Class WellKnownTelemetryNames

Namespace

Cratis.Arc

Assembly

Cratis.Arc.Core.dll

The span, attribute, event and metric names Arc's telemetry uses, for building queries, dashboards and alerts.

public static class WellKnownTelemetryNames

Inheritance

object

WellKnownTelemetryNames

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Every attribute carries a type, a name, an identifier or an outcome - never a value taken from a command, query or event payload. A payload value can be personal data, and a telemetry backend keeps it long after the application has forgotten it.

Fields

AuthorizationDeniedEvent

The event raised when authorization denied an operation.

public const string AuthorizationDeniedEvent = "cratis.arc.authorization.denied"

Field Value

string

CommandAuthorizeSpan

The span raised when an authorization filter decides on a command.

public const string CommandAuthorizeSpan = "cratis.arc.command.authorize"

Field Value

string

CommandDurationMetric

The histogram recording how long a command took, in seconds.

public const string CommandDurationMetric = "cratis.arc.command.duration"

Field Value

string

CommandExecuteSpan

The span raised when a command runs through the pipeline.

public const string CommandExecuteSpan = "cratis.arc.command.execute"

Field Value

string

CommandFilterSpan

The span raised when the command filters run.

public const string CommandFilterSpan = "cratis.arc.command.filter"

Field Value

string

CommandHandleSpan

The span raised when a command handler runs.

public const string CommandHandleSpan = "cratis.arc.command.handle"

Field Value

string

CommandKeyType

The attribute holding the type the command declares its key as, such as its event source id.

public const string CommandKeyType = "cratis.arc.command.key.type"

Field Value

string

CommandOutcome

The attribute holding the outcome of a command, one of WellKnownOperationOutcomes.

public const string CommandOutcome = "cratis.arc.command.outcome"

Field Value

string

CommandOutcomesMetric

The counter recording command outcomes.

public const string CommandOutcomesMetric = "cratis.arc.command.outcomes"

Field Value

string

CommandProvideSpan

The span raised when a model-bound command's Provide() method runs.

public const string CommandProvideSpan = "cratis.arc.command.provide"

Field Value

string

CommandType

The attribute holding the full name of the command type.

public const string CommandType = "cratis.arc.command.type"

Field Value

string

CommandValidateSpan

The span raised when a command is validated without being run.

public const string CommandValidateSpan = "cratis.arc.command.validate"

Field Value

string

CorrelationId

The attribute holding the correlation id.

public const string CorrelationId = "cratis.correlation_id"

Field Value

string

ExceptionEvent

The OpenTelemetry semantic convention event for an exception.

public const string ExceptionEvent = "exception"

Field Value

string

ExceptionType

The OpenTelemetry semantic convention attribute for the type of an exception.

public const string ExceptionType = "exception.type"

Field Value

string

ObservableTransport

The transport of a query that keeps pushing changes.

public const string ObservableTransport = "observable"

Field Value

string

Other

The value recorded for a command type or query name past the cardinality limit, or for a query that is not known.

public const string Other = "_other"

Field Value

string

QueryDurationMetric

The histogram recording how long a query took, in seconds.

public const string QueryDurationMetric = "cratis.arc.query.duration"

Field Value

string

QueryName

The attribute holding the fully qualified name of the query.

public const string QueryName = "cratis.arc.query.name"

Field Value

string

QueryOutcome

The attribute holding the outcome of a query, one of WellKnownOperationOutcomes.

public const string QueryOutcome = "cratis.arc.query.outcome"

Field Value

string

QueryPerformSpan

The span raised when a query runs through the pipeline.

public const string QueryPerformSpan = "cratis.arc.query.perform"

Field Value

string

QueryPushSpan

The span raised when a changed result of an observable query is pushed to a subscriber.

public const string QueryPushSpan = "cratis.arc.query.push"

Field Value

string

QueryPushesMetric

The counter recording the results pushed to observable query subscribers.

public const string QueryPushesMetric = "cratis.arc.query.pushes"

Field Value

string

QuerySubscriptionsMetric

The up-down counter recording the observable query subscriptions that are active.

public const string QuerySubscriptionsMetric = "cratis.arc.query.subscriptions"

Field Value

string

QueryTransport

The attribute holding the transport a query result is delivered over.

public const string QueryTransport = "cratis.arc.query.transport"

Field Value

string

ServerSentEventsTransport

The transport of an observable query delivered as Server-Sent Events.

public const string ServerSentEventsTransport = "sse"

Field Value

string

SnapshotTransport

The transport of a query answered once.

public const string SnapshotTransport = "snapshot"

Field Value

string

Tenant

The attribute holding the resolved tenant.

public const string Tenant = "cratis.tenant"

Field Value

string

UnknownTransport

The transport recorded for a query that failed before it ran.

public const string UnknownTransport = "unknown"

Field Value

string

ValidationFailedEvent

The event raised for each validation result that blocked an operation.

public const string ValidationFailedEvent = "cratis.arc.validation.failed"

Field Value

string

ValidationMembers

The event attribute holding the members a validation result is for.

public const string ValidationMembers = "cratis.arc.validation.members"

Field Value

string

ValidationReason

The event attribute holding what composed a validation result.

public const string ValidationReason = "cratis.arc.validation.reason"

Field Value

string

ValidationReasonDetail

The event attribute holding the identity of what composed a validation result, such as a constraint name.

public const string ValidationReasonDetail = "cratis.arc.validation.reason_detail"

Field Value

string

ValidationResultCount

The attribute holding the number of results a validator produced.

public const string ValidationResultCount = "cratis.arc.validation.result_count"

Field Value

string

ValidationSeverity

The event attribute holding the severity of a validation result.

public const string ValidationSeverity = "cratis.arc.validation.severity"

Field Value

string

ValidatorInvokeSpan

The span raised when a validator runs.

public const string ValidatorInvokeSpan = "cratis.arc.validator.invoke"

Field Value

string

ValidatorType

The attribute holding the full name of a validator type.

public const string ValidatorType = "cratis.arc.validator.type"

Field Value

string

WebSocketTransport

The transport of an observable query delivered over a WebSocket.

public const string WebSocketTransport = "websocket"

Field Value

string