Skip to content

Orleans metrics catalog

This catalog lists every instrument created for the Microsoft.Orleans meter in the current source tree. Core runtime instruments are available when their component runs. Streaming, transactions, durable jobs, journaling, and provider-specific instruments appear only when those features are configured. Discover the instruments emitted by the deployed Orleans version because releases and configured packages can differ.

The Unit column gives the natural unit recorded by Orleans. “Implicit” means the instrument doesn’t set unit metadata. TimeSpan ticks are 100 nanoseconds. The Attributes column lists attributes added by Orleans; resource attributes such as service.instance.id also identify each time series.

Instrument types use these abbreviations:

Some instruments retain historical types or unit strings. The descriptions below state the runtime behavior so queries can preserve those semantics.

InstrumentTypeUnitAttributesDescription
orleans-app-requests-canceledCRequests, implicitgrain_typeOutbound grain requests canceled by their caller.
orleans-app-requests-latency-bucketOCMilliseconds, implicitdurationCompleted outbound request callbacks in one latency band. Bands are mutually exclusive, range from 1ms through 15000ms, and include an overflow band.
orleans-app-requests-latency-countOCRequests, implicit-Total completed outbound request callbacks represented by the latency bands.
orleans-app-requests-latency-sumOCMilliseconds, implicit-Sum of caller-observed elapsed time for completed outbound request callbacks.
orleans-app-requests-timedoutCRequests, implicitgrain_typeOutbound grain requests which exceeded the configured response timeout.
orleans-client-connected-gatewaysOGGateways, implicit-Gateway connections currently held by an Orleans client.

Request latency covers the interval until the caller’s callback completes, including terminal timeout, cancellation, target-silo failure, and host-shutdown paths.

InstrumentTypeUnitAttributesDescription
orleans-gateway-connected-clientsUDCClients, implicit-Client identities currently tracked by a silo gateway, including disconnected clients retained during the configured drop timeout.
orleans-gateway-load-sheddingCMessages, implicit-Client requests rejected because the gateway overload detector reported saturation.
orleans-gateway-receivedCMessages, implicit-Messages received by a silo through a client gateway connection.
orleans-gateway-sentCMessages, implicit-Gateway message-send events, including messages written to client connections.
orleans-messaging-expiredCMessages, implicitPhaseMessages which expired during Send, Receive, Dispatch, Invoke, or Respond.
orleans-messaging-pings-receivedCPings, implicitDestinationMembership probe messages received from the identified silo address.
orleans-messaging-pings-reply-missedCReplies, implicitDestinationDirect or indirect membership probes which didn’t receive a successful reply from the identified silo address.
orleans-messaging-pings-reply-receivedCReplies, implicitDestinationSuccessful direct or indirect membership probe replies from the identified silo address.
orleans-messaging-pings-sentCPings, implicitDestinationMembership probe messages sent to the identified silo address.
orleans-messaging-processing-activation-dataOGRequests, implicit-Requests currently queued or executing across all grain activations on the silo.
orleans-messaging-processing-dispatcher-forwardedOCMessages, implicit-Messages forwarded by the dispatcher.
orleans-messaging-processing-dispatcher-processedOCMessages, implicitDirection, StatusMessages processed by the dispatcher, split by message direction and Ok or Error result.
orleans-messaging-processing-dispatcher-receivedOCMessages, implicitContext, DirectionMessages received by the dispatcher, split by message direction and whether a grain runtime context was present.
orleans-messaging-processing-ima-enqueuedOCMessages, implicitContextMessages enqueued to an incoming-message-agent target: ToNull, ToSystemTarget, or ToGrain.
orleans-messaging-processing-ima-receivedOCMessages, implicit-Messages received by the incoming message agent.
orleans-messaging-received-header-sizeOCbytes-Cumulative serialized header bytes received by the process.
orleans-messaging-received-messages-sizeHbytesConnectionDirection, MessageDirection, optional siloDistribution of total received message sizes.
orleans-messaging-rejectedCMessages, implicitDirectionMessages rejected by the runtime.
orleans-messaging-reroutedCMessages, implicitDirectionMessages rerouted after their original route couldn’t be used.
orleans-messaging-sent-droppedCMessages, implicitDirectionOutbound messages dropped before successful transmission.
orleans-messaging-sent-failedCMessages, implicitDirectionOutbound messages whose send attempt failed.
orleans-messaging-sent-header-sizeOCbytes-Cumulative serialized header bytes sent by the process.
orleans-messaging-sent-localOCMessages, implicit-Messages delivered locally without a network send.
orleans-messaging-sent-messages-sizeHbytesConnectionDirection, MessageDirection, optional siloDistribution of total sent message sizes.
orleans-networking-sockets-closedCSockets, implicitDirectionNetwork connections closed, split by connection direction.
orleans-networking-sockets-openedCSockets, implicitDirectionNetwork connections opened, split by connection direction.

Destination and silo contain silo addresses and incarnations. They are useful during incident diagnosis and can create new time series during restarts.

InstrumentTypeUnitAttributesDescription
orleans-catalog-activation-collectionsCScans, implicit-Activation-collection scans performed by the silo.
orleans-catalog-activation-concurrent-registration-attemptsCAttempts, implicit-Activation registrations which encountered an activation already registered elsewhere.
orleans-catalog-activation-createdCActivations, implicit-Activation objects created on the silo.
orleans-catalog-activation-destroyedCActivations, implicit-Activations removed from the silo catalog.
orleans-catalog-activation-failed-to-activateCActivations, implicit-Activations whose lifecycle initialization failed or was canceled.
orleans-catalog-activation-latencyHmsstatus, directoryActivation duration, split by outcome and whether the grain uses the directory. Status values include success, canceled, directory_error, duplicate, and error.
orleans-catalog-activation-non-existentCMessages, implicit-Messages which targeted an activation that wasn’t present in the local catalog.
orleans-catalog-activation-shutdownCActivations, implicitviaActivation shutdowns split by collection, deactivateOnIdle, deactivateStuckActivation, or migration.
orleans-catalog-activation-working-setOGActivations, implicit-Activations currently in the silo’s active working set.
orleans-catalog-activationsOGActivations, implicit-Activations currently registered in the silo catalog.
orleans-catalog-deactivation-latencyHmsviaDeactivation duration, split by the shutdown path.
orleans-grainsUDCGrains, implicittypeCurrent grain instances by grain type.
orleans-scheduler-long-running-turnsCTurns, implicit-Grain micro-turns whose synchronous execution exceeded TurnWarningLengthThreshold.
orleans-system-targetsUDCSystem targets, implicittypeCurrent Orleans system-target instances by type.
InstrumentTypeUnitAttributesDescription
orleans-consistent-ring-range-percentage-averageOGPercent, implicit-Equal-share percentage of the consistent-hash ring for one silo (100 / ring size).
orleans-consistent-ring-range-percentage-localOGPercent, implicit-Percentage of the consistent-hash ring currently owned by this silo.
orleans-consistent-ring-sizeOGSilos, implicit-Members in the consistent-hash ring.
orleans-directory-cache-sizeOGEntries, implicit-Total entries across registered local grain-directory caches.
orleans-directory-lookups-cache-issuedCLookups, implicit-Grain-location lookups attempted against the local directory cache.
orleans-directory-lookups-cache-successesCLookups, implicit-Local directory-cache lookups which returned a usable entry.
orleans-directory-lookups-full-issuedCLookups, implicit-Full grain-directory lookups initiated by this silo.
orleans-directory-lookups-local-directory-issuedCLookups, implicit-Lookups issued directly against the local directory partition.
orleans-directory-lookups-local-directory-successesCLookups, implicit-Direct local-partition lookups which returned a grain address.
orleans-directory-lookups-local-issuedCLookups, implicit-Grain-location lookups issued through the local grain locator.
orleans-directory-lookups-local-successesCLookups, implicit-Local grain-locator lookups which returned a grain address.
orleans-directory-lookups-remote-receivedCLookups, implicit-Forwarded directory lookup requests received from another silo.
orleans-directory-lookups-remote-sentCLookups, implicit-Directory lookup requests forwarded to another silo.
orleans-directory-partition-sizeOGEntries, implicit-Grain registrations in this silo’s local directory partition.
orleans-directory-range-lock-held-durationHMilliseconds, implicit-Distribution of time directory range locks were held.
orleans-directory-recovery-countCRecoveries, implicit-Directory range recoveries completed after membership changes.
orleans-directory-recovery-durationHMilliseconds, implicit-Distribution of completed directory range-recovery durations.
orleans-directory-registration-durationHmslocator, statusGrain registration duration by locator implementation and success, canceled, or error outcome.
orleans-directory-registrationsCRegistrations, implicitlocator, statusCompleted grain registration attempts by locator implementation and outcome.
orleans-directory-registrations-single-act-issuedCRegistrations, implicit-Single-activation registration requests initiated on this silo.
orleans-directory-registrations-single-act-localCRegistrations, implicit-Single-activation registrations handled by the local directory owner.
orleans-directory-registrations-single-act-remote-receivedCRegistrations, implicit-Forwarded single-activation registration requests received from another silo.
orleans-directory-registrations-single-act-remote-sentCRegistrations, implicit-Single-activation registration requests forwarded to another silo.
orleans-directory-ring-local-portion-average-percentageOGPercent, implicit-Equal-share percentage of the local grain-directory ring (100 / ring size).
orleans-directory-ring-local-portion-distanceOGHash-ring distance, implicit-Raw hash-ring distance from this silo to its successor.
orleans-directory-ring-local-portion-percentageOGPercent, implicit-Percentage of the local grain-directory ring assigned to this silo.
orleans-directory-ring-sizeOGSilos, implicit-Members in the local grain-directory ring.
orleans-directory-snapshot-transfer-countCTransfers, implicit-Directory range snapshots successfully received from the previous partition owner.
orleans-directory-snapshot-transfer-durationHMilliseconds, implicit-Distribution of successful directory snapshot-transfer durations.
orleans-directory-unregistrations-issuedCUnregistrations, implicit-Single grain-unregistration requests initiated on this silo.
orleans-directory-unregistrations-localCUnregistrations, implicit-Single grain-unregistration requests handled by the local directory owner.
orleans-directory-unregistrations-many-issuedCRequests, implicit-Batch grain-unregistration requests initiated on this silo.
orleans-directory-unregistrations-many-remote-receivedCRequests, implicit-Forwarded batch unregistration requests received from another silo.
orleans-directory-unregistrations-many-remote-sentCRequests, implicit-Batch unregistration requests forwarded to another silo.
orleans-directory-unregistrations-remote-receivedCUnregistrations, implicit-Forwarded single unregistration requests received from another silo.
orleans-directory-unregistrations-remote-sentCUnregistrations, implicit-Single unregistration requests forwarded to another silo.
orleans-directory-validations-cache-receivedCRequests, implicit-Batch directory-cache validation requests received from another silo.

Reminders, storage, runtime resources, and watchdog

Section titled “Reminders, storage, runtime resources, and watchdog”
InstrumentTypeUnitAttributesDescription
orleans-reminders-activeOGReminders, implicit-Upper bound on reminders tracked locally, including temporary tombstones.
orleans-reminders-tardinessHseconds-Delay between a reminder’s scheduled tick time and the time delivery begins.
orleans-reminders-ticks-deliveredCTicks, implicit-Reminder ticks successfully delivered to IRemindable.ReceiveReminder.
orleans-runtime-available-memoryOGMB-GC-reported available memory budget, divided by 1,024 squared.
orleans-runtime-total-physical-memoryOGMB-TotalAvailableMemoryBytes, divided by 1,024 squared. The historical name can represent a process or container memory limit instead of host physical RAM.
orleans-storage-clear-errorsCErrors, implicitprovider_type_name, state_name, state_typeGrain-state clear operations which threw an exception.
orleans-storage-clear-latencyHmsprovider_type_name, state_name, state_typeLatency of successfully completed grain-state clear operations.
orleans-storage-read-errorsCErrors, implicitprovider_type_name, state_name, state_typeGrain-state read operations which threw an exception.
orleans-storage-read-latencyHmsprovider_type_name, state_name, state_typeLatency of successfully completed grain-state reads.
orleans-storage-write-errorsCErrors, implicitprovider_type_name, state_name, state_typeGrain-state write operations which threw an exception.
orleans-storage-write-latencyHmsprovider_type_name, state_name, state_typeLatency of successfully completed grain-state writes.
orleans-watchdog-health-checksCChecks, implicit-Runtime watchdog health checks performed.
orleans-watchdog-health-checks-failedCChecks, implicit-Runtime watchdog health checks which reported failure.

Pub/sub instruments use provider and grain_type. Persistent-stream read instruments use provider and queue; sent instruments use provider and grain_type. Default receiver and cache monitors use QueueId, and default block-pool monitors use BlockPoolId. Custom monitor implementations can choose different dimensions.

InstrumentTypeUnitAttributesDescription
orleans-streams-block-pool-allocated-memoryOCbytesDefault: BlockPoolIdCumulative bytes allocated from the stream buffer pool.
orleans-streams-block-pool-available-memoryOCbytesDefault: BlockPoolIdCurrent available bytes reported by the stream buffer pool. This point-in-time value is implemented as an observable counter.
orleans-streams-block-pool-claimed-memoryOCbytesDefault: BlockPoolIdCurrent claimed bytes reported by the stream buffer pool. This point-in-time value is implemented as an observable counter.
orleans-streams-block-pool-released-memoryOCbytesDefault: BlockPoolIdCumulative bytes released to the stream buffer pool.
orleans-streams-block-pool-total-memoryOCbytesDefault: BlockPoolIdCurrent total bytes reported by the stream buffer pool. This point-in-time value is implemented as an observable counter.
orleans-streams-persistent-stream-messages-readCBatch containers, implicitprovider, queueBatch containers read from persistent-stream receiver queues. One container can hold multiple stream events.
orleans-streams-persistent-stream-messages-sentCBatch containers, implicitprovider, grain_typeBatch containers selected for consumer delivery. The counter increments before delivery, so it isn’t a successful-delivery count.
orleans-streams-persistent-stream-pubsub-cache-sizeOGEntries, implicitnamePub/sub cache entries held by a persistent-stream pulling agent.
orleans-streams-persistent-stream-pulling-agentsOGAgents, implicitnamePulling agents currently owned by a persistent-stream provider on this silo.
orleans-streams-pubsub-consumersC, signed deltasConsumers, implicitprovider, grain_typeSigned cumulative consumer-registration deltas recorded by this process, using positive additions and negative removals. The series isn’t initialized from persisted pub/sub state and isn’t a point-in-time count.
orleans-streams-pubsub-consumers-addedCAttempts, implicitprovider, grain_typePub/sub consumer registration attempts.
orleans-streams-pubsub-consumers-removedCAttempts, implicitprovider, grain_typePub/sub consumer unregistration attempts.
orleans-streams-pubsub-producersC, signed deltasProducers, implicitprovider, grain_typeSigned cumulative producer-registration deltas recorded by this process, using positive additions and negative removals. The series isn’t initialized from persisted pub/sub state and isn’t a point-in-time count.
orleans-streams-pubsub-producers-addedCAttempts, implicitprovider, grain_typePub/sub producer registration attempts.
orleans-streams-pubsub-producers-removedCAttempts, implicitprovider, grain_typePub/sub producer unregistration attempts.
orleans-streams-queue-cache-lengthOCmessagesDefault: QueueIdCurrent number of messages in a queue cache. This point-in-time value is implemented as an observable counter.
orleans-streams-queue-cache-memory-allocatedOCBytes, implicitDefault: QueueIdCumulative bytes allocated by a queue cache.
orleans-streams-queue-cache-memory-releasedOCBytes, implicitDefault: QueueIdCumulative bytes released by a queue cache.
orleans-streams-queue-cache-messages-addedOCMessages, implicitDefault: QueueIdCumulative messages added to a queue cache.
orleans-streams-queue-cache-messages-purgedOCMessages, implicitDefault: QueueIdCumulative messages purged from a queue cache.
orleans-streams-queue-cache-oldest-ageOGTimeSpan ticks, implicitDefault: QueueIdAge of the oldest dequeued message still represented by the cache monitor.
orleans-streams-queue-cache-oldest-to-newest-durationOGTimeSpan ticks, implicitDefault: QueueIdEnqueue-time span from the oldest to newest messages represented by the cache monitor.
orleans-streams-queue-cache-pressureOGRatio, implicitDefault: QueueId, PressureMonitorTypeCurrent pressure value reported by each cache pressure monitor.
orleans-streams-queue-cache-pressure-contribution-countOGContributions, implicitDefault: QueueId, PressureMonitorTypePressure-contribution count reported by each cache pressure monitor.
orleans-streams-queue-cache-sizeOCbytesDefault: QueueIdCurrent queue-cache size. This point-in-time value is implemented as an observable counter.
orleans-streams-queue-cache-under-pressureOGBoolean (0 or 1), implicitDefault: QueueId, PressureMonitorTypeWhether each cache pressure monitor currently reports pressure.
orleans-streams-queue-initialization-durationCTimeSpan ticks, implicitDefault: QueueIdCumulative duration of queue receiver initialization calls.
orleans-streams-queue-initialization-exceptionsCExceptions, implicitDefault: QueueIdQueue receiver initialization calls which supplied an exception.
orleans-streams-queue-initialization-failuresCFailures, implicitDefault: QueueIdQueue receiver initialization calls reported as unsuccessful.
orleans-streams-queue-messages-receivedOCMessages, implicitDefault: QueueIdCumulative messages received from a stream queue.
orleans-streams-queue-newest-message-enqueue-ageOGTimeSpan ticks, implicitDefault: QueueIdAge of the newest message returned by the latest queue read.
orleans-streams-queue-oldest-message-enqueue-ageOGTimeSpan ticks, implicitDefault: QueueIdAge of the oldest message returned by the latest queue read.
orleans-streams-queue-read-durationCTimeSpan ticks, implicitDefault: QueueIdCumulative duration of queue receiver read calls.
orleans-streams-queue-read-exceptionsCExceptions, implicitDefault: QueueIdQueue receiver read calls which supplied an exception.
orleans-streams-queue-read-failuresCFailures, implicitDefault: QueueIdQueue receiver read calls reported as unsuccessful.
orleans-streams-queue-shutdown-durationCTimeSpan ticks, implicitDefault: QueueIdCumulative duration of queue receiver shutdown calls.
orleans-streams-queue-shutdown-exceptionsCExceptions, implicitDefault: QueueIdQueue receiver shutdown calls which supplied an exception.
orleans-streams-queue-shutdown-failuresCFailures, implicitDefault: QueueIdQueue receiver shutdown calls reported as unsuccessful.

Failure and exception counters can both increment for one operation. Duration counters aggregate total elapsed ticks; divide their increase by the matching operation count when calculating a windowed mean.

InstrumentTypeUnitAttributesDescription
orleans-transactions-failedOCTransactions, implicit-Transactions which completed unsuccessfully.
orleans-transactions-startedOCTransactions, implicit-Transactions started by the local transaction agent.
orleans-transactions-successfulOCTransactions, implicit-Transactions which completed successfully.
orleans-transactions-throttledOCTransactions, implicit-Transaction attempts rejected by transaction-agent throttling.
InstrumentTypeUnitAttributesDescription
orleans-durablejobs-cancel-job-call-durationHmsstatusDuration of cancel-job API calls, split by ok, not_found, canceled, or error.
orleans-durablejobs-cancel-job-callsCCalls, implicitstatusCompleted cancel-job API calls by outcome.
orleans-durablejobs-handler-execution-durationHmsstatusDuration of completed handler executions, split by completed, canceled, or failed.
orleans-durablejobs-handler-executionsCExecutions, implicitstatusHandler executions which reached a terminal outcome.
orleans-durablejobs-handler-executions-startedCExecutions, implicit-Durable-job handler executions started.
orleans-durablejobs-job-attempt-durationHmsstatusDuration of job attempts ending as completed, failed, or retried.
orleans-durablejobs-job-attempts-startedCAttempts, implicit-Durable-job attempts started.
orleans-durablejobs-job-dispatch-lagHms-Delay between a job’s due time and the start of its attempt.
orleans-durablejobs-job-schedule-durationHms-Time required to persist and schedule a job.
orleans-durablejobs-jobs-canceledCJobs, implicit-Durable jobs canceled.
orleans-durablejobs-jobs-completedCJobs, implicit-Durable jobs completed successfully.
orleans-durablejobs-jobs-failedCJobs, implicit-Durable-job attempts recorded as failed.
orleans-durablejobs-jobs-retriedCJobs, implicit-Durable-job attempts scheduled for retry.
orleans-durablejobs-jobs-scheduledCJobs, implicit-Durable jobs successfully scheduled.
orleans-durablejobs-ownership-check-durationHms-Duration of shard-ownership checks.
orleans-durablejobs-schedule-job-call-durationHmsstatusDuration of schedule-job API calls, split by ok, canceled, or error.
orleans-durablejobs-schedule-job-callsCCalls, implicitstatusCompleted schedule-job API calls by outcome.
orleans-durablejobs-shard-batch-bytesHbytes-Serialized byte size of durable-job shard mutation batches.
orleans-durablejobs-shard-batch-mutationsHMutations, implicit-Mutation count in durable-job shard batches.
orleans-durablejobs-shard-pending-depthHMutations, implicit-Pending mutation operations collected into each shard batch immediately before processing.
orleans-durablejobs-shard-processing-durationHmsstatusShard processing duration, split by completed, canceled, or error.
orleans-durablejobs-shards-processedCShards, implicitstatusShard processing passes completed by outcome.
orleans-durablejobs-storage-batch-sizeHMutations, implicitstatusApplied shard mutations included in each state-write attempt, split by outcome.
orleans-durablejobs-storage-batchesCBatches, implicitstatusDurable-job storage batches written, canceled, or failed.
orleans-durablejobs-stripe-distributionCAssignments, implicitstripeJob assignments by durable-job stripe number.

Core journaling instruments use operation and status where applicable. Operation values include append, snapshot, replace, read, delete, and recovery; status is ok or error.

InstrumentTypeUnitAttributesDescription
orleans-journaling-compaction-triggersCTriggers, implicitreasonJournal compactions requested because of user_snapshot, storage_requested, or migration.
orleans-journaling-gather-durationHmsoperationTime spent gathering journal state for a storage operation.
orleans-journaling-recoveriesCRecoveries, implicitoperation, statusJournal recovery attempts by outcome.
orleans-journaling-recovery-durationHmsoperation, statusJournal recovery duration by outcome.
orleans-journaling-state-delete-durationHmsoperation, statusDuration of journaled-state delete requests.
orleans-journaling-state-delete-requestsCRequests, implicitoperation, statusJournaled-state delete requests by outcome.
orleans-journaling-state-scan-countHStates, implicitoperationJournal states scanned while gathering work for an operation.
orleans-journaling-state-write-durationHmsoperation, statusDuration of journaled-state write requests.
orleans-journaling-state-write-requestsCRequests, implicitoperation, statusJournaled-state write requests by operation and outcome.
orleans-journaling-storage-bytesCbytesoperationCumulative bytes successfully processed by journal storage operations.
orleans-journaling-storage-operation-bytesHbytesoperation, statusDistribution of successful journal storage operation sizes.
orleans-journaling-storage-operation-durationHmsoperation, statusJournal storage operation duration by operation and outcome.
orleans-journaling-storage-operation-queue-durationHmsoperation, statusTime journal storage operations spent queued before execution.
orleans-journaling-storage-operationsCOperations, implicitoperation, statusJournal storage operations by operation and outcome.
orleans-journaling-write-coalesced-callersHCallers, implicitoperationNumber of callers combined into each coalesced journal write.

Azure journaling storage instruments use operations create, get_metadata, update_metadata, append, delete, read, and replace.

InstrumentTypeUnitAttributesDescription
orleans-journaling-azure-blob-operation-bytesCbytesoperationCumulative bytes successfully processed by Azure Blob journal storage operations.
orleans-journaling-azure-blob-operation-durationHmsoperation, statusAzure Blob journal storage operation duration by operation and outcome.
orleans-journaling-azure-blob-operationsCOperations, implicitoperation, statusAzure Blob journal storage operations by operation and ok or error status.
orleans-journaling-azure-table-operation-bytesCbytesoperationCumulative bytes successfully processed by Azure Table journal storage operations.
orleans-journaling-azure-table-operation-durationHmsoperation, statusAzure Table journal storage operation duration by operation and outcome.
orleans-journaling-azure-table-operationsCOperations, implicitoperation, statusAzure Table journal storage operations by operation and ok or error status.

Use Monitor Orleans metrics to select health indicators, aggregate each instrument according to its type, control cardinality, and build alerts. Use Troubleshoot Orleans incidents to correlate metrics with logs, traces, deployment changes, and dependency health.