Endpoint | Description |
---|---|
https://metrics.streamnative.cloud/v1/cloud/metrics/export | Export Pulsar resource metrics |
https://metrics.streamnative.cloud/v1/cloud/metrics/source/export | Export Source connector metrics |
https://metrics.streamnative.cloud/v1/cloud/metrics/sink/export | Export Sink connector metrics |
https://metrics.streamnative.cloud/v1/cloud/metrics/function/export | Export Function metrics |
https://metrics.streamnative.cloud/v1/cloud/metrics/kafkaconnect/export | Export Kafka Connect metrics |
https://metrics.streamnative.cloud/v1/cloud/metrics/health/export | Export Cluster health metrics |
metrics-viewer
role.
metrics-viewer
, your can configure it through snctl
or terraform
.
Name | Type | Description |
---|---|---|
pulsar_topics_count | Gauge | The number of Pulsar topics of the namespace owned by this broker. |
pulsar_subscriptions_count | Gauge | The number of Pulsar subscriptions of the topic served by this broker. |
pulsar_producers_count | Gauge | The number of active producers of the topic connected to this broker. |
pulsar_consumers_count | Gauge | The number of active consumers of the topic connected to this broker. |
pulsar_rate_in | Gauge | The total message rate of the namespace coming into this broker (message/second). |
pulsar_rate_out | Gauge | The total message rate of the namespace going out from this broker (message/second). |
pulsar_throughput_in | Gauge | The total throughput of the topic coming into this broker (byte per second). |
pulsar_throughput_out | Gauge | The total throughput of the topic going out from this broker (byte per second). |
pulsar_storage_size | Gauge | The total storage size of the topics in this topic owned by this broker (bytes). |
pulsar_storage_backlog_size | Gauge | The total backlog size of the topics of this topic owned by this broker (in bytes). |
pulsar_storage_offloaded_size | Gauge | The total amount of the data in this topic offloaded to the tiered storage (bytes). |
pulsar_storage_write_rate | Gauge | The total message batches (entries) written to the storage for this topic (message batch per second). |
pulsar_storage_read_rate | Gauge | The total message batches (entries) read from the storage for this topic (message batch per second). |
pulsar_subscription_delayed | Gauge | The total message batches (entries) are delayed for dispatching. |
pulsar_broker_publish_latency | Summary | The total latency of pulsar broker publish. |
Name | Type | Description |
---|---|---|
pulsar_source_written_total | Counter | The total number of records written to a Pulsar topic |
pulsar_source_written_1min_total | Counter | The total number of records written to a Pulsar topic in the last 1 minute |
pulsar_source_received_total | Counter | The total number of records received from source |
pulsar_source_received_1min_total | Counter | The total number of records received from source in the last 1 minute |
pulsar_source_last_invocation | Gauge | The timestamp of the last invocation of the source |
pulsar_source_source_exception | Gauge | The exception from a source |
pulsar_source_source_exceptions_total | Counter | The total number of source exceptions |
pulsar_source_source_exceptions_1min_total | Counter | The total number of source exceptions in the last 1 minute |
pulsar_source_system_exception | Gauge | The exception from system code |
pulsar_source_system_exceptions_total | Counter | The total number of system exceptions |
pulsar_source_system_exceptions_1min_total | Counter | The total number of system exceptions in the last 1 minute |
pulsar_source_user_metric_* | Summary | The user-defined metrics |
process_cpu_seconds_total | Counter | Total user and system CPU time spent in seconds. |
jvm_memory_bytes_committed | Gauge | Committed (bytes) of a given JVM memory area. |
jvm_memory_bytes_max | Gauge | Max (bytes) of a given JVM memory area. |
jvm_memory_direct_bytes_used | Gauge | Used bytes of a given JVM memory area. |
jvm_memory_bytes_init | Gauge | Initial bytes of a given JVM memory area. |
jvm_gc_collection_seconds_sum | Summary | Time spent in a given JVM garbage collector in seconds. |
Name | Type | Description |
---|---|---|
pulsar_sink_written_total | Counter | The total number of records written to a Pulsar topic |
pulsar_sink_written_1min_total | Counter | The total number of records written to a Pulsar topic in the last 1 minute |
pulsar_sink_received_total | Counter | The total number of records received from sink |
pulsar_sink_received_1min_total | Counter | The total number of records received from sink in the last 1 minute |
pulsar_sink_last_invocation | Gauge | The timestamp of the last invocation of the sink |
pulsar_sink_sink_exception | Gauge | The exception from a sink |
pulsar_sink_sink_exceptions_total | Counter | The total number of sink exceptions |
pulsar_sink_sink_exceptions_1min_total | Counter | The total number of sink exceptions in the last 1 minute |
pulsar_sink_system_exception | Gauge | The exception from system code |
pulsar_sink_system_exceptions_total | Counter | The total number of system exceptions |
pulsar_sink_system_exceptions_1min_total | Counter | The total number of system exceptions in the last 1 minute |
pulsar_sink_user_metric_* | Summary | The user-defined metrics |
process_cpu_seconds_total | Counter | Total user and system CPU time spent in seconds. |
jvm_memory_bytes_committed | Gauge | Committed (bytes) of a given JVM memory area. |
jvm_memory_bytes_max | Gauge | Max (bytes) of a given JVM memory area. |
jvm_memory_direct_bytes_used | Gauge | Used bytes of a given JVM memory area. |
jvm_memory_bytes_init | Gauge | Initial bytes of a given JVM memory area. |
jvm_gc_collection_seconds_sum | Summary | Time spent in a given JVM garbage collector in seconds. |
Name | Type | Description |
---|---|---|
pulsar_function_processed_successfully_total | Counter | The total number of messages processed successfully |
pulsar_function_processed_successfully_1min_total | Counter | The total number of messages processed successfully in the last 1 minute |
pulsar_function_system_exceptions_total | Counter | The total number of system exceptions |
pulsar_function_system_exceptions_1min_total | Counter | The total number of system exceptions in the last 1 minute |
pulsar_function_user_exceptions_total | Counter | The total number of user exceptions |
pulsar_function_user_exceptions_1min_total | Counter | The total number of user exceptions in the last 1 minute |
pulsar_function_process_latency_ms | Summary | The process latency in milliseconds |
pulsar_function_process_latency_ms_1min | Summary | The process latency in milliseconds in the last 1 minute |
pulsar_function_last_invocation | Gauge | The timestamp of the last invocation of the function |
pulsar_function_received_total | Counter | The total number of messages received from source |
pulsar_function_received_1min_total | Counter | The total number of messages received from source in the last 1 minute |
pulsar_function_user_metric_* | Summary | The user-defined metrics |
process_cpu_seconds_total | Counter | Total user and system CPU time spent in seconds. |
jvm_memory_bytes_committed | Gauge | Committed (bytes) of a given JVM memory area. (Java Functions only) |
jvm_memory_bytes_max | Gauge | Max (bytes) of a given JVM memory area. (Java Functions only) |
jvm_memory_direct_bytes_used | Gauge | Used bytes of a given JVM memory area. (Java Functions only) |
jvm_memory_bytes_init | Gauge | Initial bytes of a given JVM memory area. (Java Functions only) |
jvm_gc_collection_seconds_sum | Summary | Time spent in a given JVM garbage collector in seconds. (Java Functions only) |
Name | Type | Description |
---|---|---|
kafka_connect_connector_task_batch_size_avg | Gauge | The average size of the batches processed by the connector |
kafka_connect_connector_task_batch_size_max | Gauge | The maximum size of the batches processed by the connector |
kafka_connect_connector_task_offset_commit_avg_time_ms | Gauge | The average time in milliseconds taken by this task to commit offsets |
kafka_connect_connector_task_offset_commit_failure_percentage | Gauge | The average percentage of this task’s offset commit attempts that failed |
kafka_connect_connector_task_offset_commit_max_time_ms | Gauge | The maximum time in milliseconds taken by this task to commit offsets |
kafka_connect_connector_task_offset_commit_success_percentage | Gauge | The average percentage of this task’s offset commit attempts that succeeded |
kafka_connect_connector_task_pause_ratio | Gauge | The fraction of time this task has spent in the pause state |
kafka_connect_connector_task_running_ratio | Gauge | The fraction of time this task has spent in the running state |
kafka_connect_source_task_source_record_poll | Gauge | The total number of records produced/polled (before transformation) by this task belonging to the named source connector in this worker |
kafka_connect_source_task_source_record_poll_rate | Gauge | The average per-second number of records produced/polled (before transformation) by this task belonging to the named source connector in this worker |
kafka_connect_source_task_source_record_write | Gauge | The number of records output from the transformations and written to Kafka for this task belonging to the named source connector in this worker, since the task was last restarted |
kafka_connect_source_task_source_record_write_rate | Gauge | The average per-second number of records output from the transformations and written to Kafka for this task belonging to the named source connector in this worker |
kafka_connect_source_task_poll_batch_avg_time_ms | Gauge | The average time in milliseconds taken by this task to poll for a batch of source records |
kafka_connect_source_task_poll_batch_max_time_ms | Gauge | The maximum time in milliseconds taken by this task to poll for a batch of source records |
kafka_connect_source_task_source_record_active_count | Gauge | The number of records that have been produced by this task but not yet completely written to Kafka |
kafka_connect_source_task_source_record_active_count_avg | Gauge | The average number of records that have been produced by this task but not yet completely written to Kafka |
kafka_connect_source_task_source_record_active_count_max | Gauge | The maximum number of records that have been produced by this task but not yet completely written to Kafka |
kafka_connect_sink_task_offset_commit_completion | Gauge | The total number of offset commit completions that were completed successfully |
kafka_connect_sink_task_offset_commit_completion_rate | Gauge | The average per-second number of offset commit completions that were completed successfully |
kafka_connect_sink_task_offset_commit_seq_no | Gauge | The current sequence number for offset commits |
kafka_connect_sink_task_offset_commit_skip | Gauge | The total number of offset commit completions that were received too late and skipped/ignored |
kafka_connect_sink_task_offset_commit_skip_rate | Gauge | The average per-second number of offset commit completions that were received too late and skipped/ignored |
kafka_connect_sink_task_partition_count | Gauge | The number of topic partitions assigned to this task belonging to the named sink connector in this worker |
kafka_connect_sink_task_put_batch_avg_time_ms | Gauge | The average time taken by this task to put a batch of sinks records |
kafka_connect_sink_task_put_batch_max_time_ms | Gauge | The maximum time taken by this task to put a batch of sinks records |
kafka_connect_sink_task_sink_record_active_count | Gauge | The number of records that have been read from Kafka but not yet completely committed/flushed/acknowledged by the sink task |
kafka_connect_sink_task_sink_record_active_count_avg | Gauge | The average number of records that have been read from Kafka but not yet completely committed/flushed/acknowledged by the sink task |
kafka_connect_sink_task_sink_record_active_count_max | Gauge | The maximum number of records that have been read from Kafka but not yet completely committed/flushed/acknowledged by the sink task |
kafka_connect_sink_task_sink_record_read | Gauge | The total number of records read from Kafka by this task belonging to the named sink connector in this worker, since the task was last restarted |
kafka_connect_sink_task_sink_record_read_rate | Gauge | The average per-second number of records read from Kafka for this task belonging to the named sink connector in this worker. This is before transformations are applied |
kafka_connect_sink_task_sink_record_send | Gauge | The total number of records output from the transformations and sent/put to this task belonging to the named sink connector in this worker, since the task was last restarted |
kafka_connect_sink_task_sink_record_send_rate | Gauge | The average per-second number of records output from the transformations and sent/put to this task belonging to the named sink connector in this worker |
kafka_connect_task_error_deadletterqueue_produce_failures | Gauge | The number of failed writes to the dead letter queue |
kafka_connect_task_error_deadletterqueue_produce_requests | Gauge | The number of attempted writes to the dead letter queue |
kafka_connect_task_error_last_error_timestamp | Gauge | The epoch timestamp when this task last encountered an error |
kafka_connect_task_error_total_errors_logged | Gauge | The total number of errors that were logged |
kafka_connect_task_error_total_record_errors | Gauge | The total number of record processing errors in this task |
kafka_connect_task_error_total_record_failures | Gauge | The total number of record processing failures in this task |
kafka_connect_task_error_total_records_skipped | Gauge | The total number of records skipped due to errors |
kafka_connect_task_error_total_retries | Gauge | The total number of operations retried |
kafka_connect_worker_connector_destroyed_task_count | Gauge | The number of destroyed tasks of the connector on the worker |
kafka_connect_worker_connector_failed_task_count | Gauge | The number of failed tasks of the connector on the worker |
kafka_connect_worker_connector_paused_task_count | Gauge | The number of paused tasks of the connector on the worker |
kafka_connect_worker_connector_restarting_task_count | Gauge | The number of restarting tasks of the connector on the worker |
kafka_connect_worker_connector_running_task_count | Gauge | The number of running tasks of the connector on the worker |
kafka_connect_worker_connector_total_task_count | Gauge | The number of tasks of the connector on the worker |
kafka_connect_worker_connector_unassigned_task_count | Gauge | The number of unassigned tasks of the connector on the worker |
process_cpu_seconds_total | Counter | Total user and system CPU time spent in seconds |
jvm_memory_committed_bytes | Gauge | Committed (bytes) of a given JVM memory area |
jvm_memory_max_bytes | Gauge | Max (bytes) of a given JVM memory area |
jvm_memory_init_bytes | Gauge | Initial bytes of a given JVM memory area |
jvm_memory_used_bytes | Gauge | Used bytes of a given JVM memory area |
jvm_gc_collection_seconds_sum | Summary | Time spent in a given JVM garbage collector in seconds |
Name | Type | Description |
---|---|---|
pulsar_detector_e2e_latency_ms | Summary | The latency distribution from message sending to message consumption |
pulsar_detector_publish_latency_ms | Summary | The latency distribution of message sending |
pulsar_detector_pulsar_sla_messaging_up | Gauge | The gauge for indicating the messaging service up or down |
pulsar_detector_pulsar_sla_webservice_up | gauge | The gauge for indicating the webservice up or down |
pulsar_detector_geo_latency_ms | Summary | The latency distribution Latency distribution from message sending to message consumption across clusters |
client_id
and client_secret
in the Key
file of a Super Admin Service Account. For more information, see work with service accounts.
The audience
parameter is the Uniform Resource Name (URN), which is a combination of the urn:sn:pulsar
, the organization name, and the Pulsar instance name at StreamNative:
scrape_timeout
parameter large enough to cover the duration of the curl request above.
Your scrape_interval
parameter should also be larger than your scrape_timeout
parameter.scape_config
for collecting metrics from StreamNative Cloud. This config should be placed in your collector’s configuration file under the following section:
remote_write
entry to the prometheus.yml
configuration file as described in the Prometheus Integration section:
metric-api.eu.newrelic.com
depending on your account configuration.storage.tsdb.retention.time
parameter:
remote_write
entry to the prometheus.yml
configuration file as described in the Prometheus Integration section:
grafana_cloud_endpoint
and grafana_cloud_username
values by selecting Prometheus at https://grafana.com/orgs/${grafana_org}
. You can find grafana_cloud_api_key
at https://grafana.com/orgs/${grafana_org}/api-keys
.
Then by running a Prometheus instance, the Pulsar metrics are scraped from the StreamNative endpoint and forwarded to Grafana Cloud:
storage.tsdb.retention.time
parameter:
conf.yaml
, with the spec of your Datadog Agent deployment configuration.client_id
: Required. You need to prepare a service account with Super Admin pemision and the client_id
can be obtained from an OAuth2 credential file.client_secret
: Required. You need to prepare a service account with Super Admin pemision andt the client_id
can be obtained from an OAuth2 credential file.audience
: Required. Audience is the Uniform Resource Name (URN), which is a combination of the urn:sn:pulsar
, your organization name, and your Pulsar instance name. {organization}
is the name of your organization and the {instance}
is the name of your instance.DD_API_KEY
: Your Datadog API key.DD_SITE
: Destination site for your metrics, traces, and logs. Set your Datadog site to: datadoghq.com
. Defaults to datadoghq.com
.your-config-yaml-file-path
: The conf.yaml
configuration file created in the first step.${DD_API_KEY}
variable:
${DD_SITE}
is your site, .
The above configuration enables the receiving of metrics from StreamNative Cloud, sets up a batch processor, which is mandatory for any non-development environment, and exports to Datadog. You can refer to this full documented example configuration file for all possible configuration options for Datadog Exporter.