diagnostic_types.h File Reference

File containing diagnostic-related types. More...

#include <stdint.h>
#include "mip/mip_namespace.h"

Include dependency graph for diagnostic_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum class	CombinationPii : uint32_t {   None = 0 , SmtpAddress = 1 << 0 , Identity = 1 << 1 , Uri = 1 << 2 ,   Fqdn = 1 << 3 , EUPI = 1 << 4 , OII = 1 << 5 , EUII = 1 << 6 ,   CustomerContent = 1 << 7 , All = 0xFFFFFFFF }
	Complete description of PII data types, if any. More...
enum class	EventLevel { Basic = 0 , ImportantServiceData = 1 , NecessaryServiceData = 2 }
	Description of event importance. More...
enum class	EventPropertyType { Double , Int64 , String }
	Underlying event property data type. More...
enum class	Pii {   None = 0 , SmtpAddress = 1 , Identity = 2 , Uri = 3 ,   Fqdn = 4 , EUPI = 5 , OII = 6 , EUII = 7 ,   CustomerContent = 8 }
	Description of PII data, if any. More...

Functions
constexpr enum CombinationPii	operator& (const enum CombinationPii selfValue, const enum CombinationPii inValue)
constexpr enum CombinationPii	operator| (const enum CombinationPii selfValue, const enum CombinationPii inValue)

Detailed Description

File containing diagnostic-related types.

Definition in file diagnostic_types.h.

Enumeration Type Documentation

CombinationPii

enum class CombinationPii : uint32_t

strong

Complete description of PII data types, if any.

Enumerator
None	Data is not PII
SmtpAddress	Data contains an SMTP address
Identity	Data contains an identity
Uri	Data contains a URI
Fqdn	Data contains a FQDN
EUPI	Data contains a End User Pseudonymous Information
OII	Data contains a Organization Identifiable Information
EUII	Data contains End User Identifiable Information
CustomerContent	Data contains Customer Content
All	Any and all Pii is represented

Definition at line 62 of file diagnostic_types.h.

                          : uint32_t {
  None =            0,          /**< Data is not PII */
  SmtpAddress =     1 << 0,     /**< Data contains an SMTP address */
  Identity =        1 << 1,     /**< Data contains an identity */
  Uri =             1 << 2,     /**< Data contains a URI */
  Fqdn =            1 << 3,     /**< Data contains a FQDN */
  EUPI =            1 << 4,     /**< Data contains a End User Pseudonymous Information */
  OII =             1 << 5,     /**< Data contains a Organization Identifiable Information */
  EUII =            1 << 6,     /**< Data contains End User Identifiable Information */
  CustomerContent = 1 << 7,     /**< Data contains Customer Content */
  All =             0xFFFFFFFF, /**< Any and all Pii is represented */
};

EventLevel

enum class EventLevel

strong

Description of event importance.

Enumerator
Basic	Data is used only for telemetry/logging purposes
ImportantServiceData	Data is necessary to track the usage of critical features
NecessaryServiceData	Data is necessary as a critical feature (e.g. audit)

Definition at line 86 of file diagnostic_types.h.

                      {
  Basic = 0,                /**< Data is used only for telemetry/logging purposes */
  ImportantServiceData = 1, /**< Data is necessary to track the usage of critical features */
  NecessaryServiceData = 2, /**< Data is necessary as a critical feature (e.g. audit) */
};

EventPropertyType

enum class EventPropertyType

strong

Underlying event property data type.

Enumerator
Double	double
Int64	int64_t
String	string

Definition at line 95 of file diagnostic_types.h.

                             {
  Double, /**< double */
  Int64,  /**< int64_t */
  String, /**< string */
};

Pii

enum class Pii

strong

Description of PII data, if any.

Note

If an event is sent through audit pipeline, this value should be forced to 'None'.

Enumerator
None	Data is not PII
SmtpAddress	Data contains an SMTP address
Identity	Data contains an identity
Uri	Data contains a URI
Fqdn	Data contains a FQDN
EUPI	Data contains a End User Pseudonymous Information
OII	Data contains a Organization Identifiable Information
EUII	Data contains End User Identifiable Information
CustomerContent	Data contains Customer Content

Definition at line 47 of file diagnostic_types.h.

               {
  None = 0,             /**< Data is not PII */
  SmtpAddress = 1,      /**< Data contains an SMTP address */
  Identity = 2,         /**< Data contains an identity */
  Uri = 3,              /**< Data contains a URI */
  Fqdn = 4,             /**< Data contains a FQDN */
  EUPI = 5,             /**< Data contains a End User Pseudonymous Information */
  OII = 6,              /**< Data contains a Organization Identifiable Information */
  EUII = 7,             /**< Data contains End User Identifiable Information */
  CustomerContent = 8,  /**< Data contains Customer Content */
};

Function Documentation

operator&()

enum CombinationPii operator& ( const enum CombinationPii selfValue, const enum CombinationPii inValue )

inlineconstexpr

Definition at line 79 of file diagnostic_types.h.

                                                                                                                       {
  return static_cast<enum CombinationPii>(uint32_t(selfValue) & uint32_t(inValue));
}

operator|()

enum CombinationPii operator| ( const enum CombinationPii selfValue, const enum CombinationPii inValue )

inlineconstexpr

Definition at line 75 of file diagnostic_types.h.

                                                                                                                       {
  return static_cast<enum CombinationPii>(uint32_t(selfValue) | uint32_t(inValue));
}