Prometheus Go ๐
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
prometheus-go
monitor type to wrap the
Prometheus Exporter to scrape Prometheus Go collector and
Prometheus process collector metrics for Splunk Observability Cloud.
This integration is available on Linux and Windows.
Benefits ๐
After you configure the integration, you can access these features:
View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata Catalog.
Installation ๐
Follow these steps to deploy this integration:
Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the integration, as described in the Configuration section.
Restart the Splunk Distribution of the OpenTelemetry Collector.
Configuration ๐
To use this integration of a Smart Agent monitor with the Collector:
Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.
Example ๐
To activate this integration, add the following to your Collector configuration:
receivers:
smartagent/prometheus-go:
type: prometheus-go
host: localhost
port: 2112
... # Additional config
Next, add the monitor to the service.pipelines.metrics.receivers
section of your configuration file:
service:
pipelines:
metrics:
receivers: [smartagent/prometheus-go]
Configuration settings ๐
The following table shows the configuration options for the
prometheus-go
monitor:
Option |
Required |
Type |
Description |
---|---|---|---|
|
no |
|
|
|
no |
|
User name to use on each request. |
|
no |
|
Password to use on each request. |
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
Path to the client TLS key to use for TLS required connections. |
|
yes |
|
Host of the exporter. |
|
yes |
|
Port of the exporter. |
|
no |
|
|
|
no |
|
|
|
no |
|
|
Metrics ๐
The following metrics are available for this integration.
Name | Description | Type |
---|---|---|
go_gc_duration_seconds | A summary of the GC invocation durations | cumulative |
go_gc_duration_seconds_bucket | A summary of the GC invocation durations | cumulative |
go_gc_duration_seconds_count | A summary of the GC invocation durations | cumulative |
go_goroutines | Number of goroutines that currently exist | gauge |
go_info | Information about the Go environment | gauge |
go_memstats_alloc_bytes | Number of bytes allocated and still in use | gauge |
go_memstats_alloc_bytes_total | Total number of bytes allocated, even if freed | cumulative |
go_memstats_buck_hash_sys_bytes | Number of bytes used by the profiling bucket hash table | gauge |
go_memstats_frees_total | Total number of frees | cumulative |
go_memstats_gc_cpu_fraction | The fraction of this program's available CPU time used by the GC since the program started | gauge |
go_memstats_gc_sys_bytes | Number of bytes used for garbage collection system metadata | gauge |
go_memstats_heap_alloc_bytes | Number of heap bytes allocated and still in use | gauge |
go_memstats_heap_idle_bytes | Number of heap bytes waiting to be used | gauge |
go_memstats_heap_inuse_bytes | Number of heap bytes that are in use | gauge |
go_memstats_heap_objects | Number of allocated objects | gauge |
go_memstats_heap_released_bytes | Number of heap bytes released to OS | gauge |
go_memstats_heap_sys_bytes | Number of heap bytes obtained from system | gauge |
go_memstats_last_gc_time_seconds | Number of seconds since 1970 of last garbage collection | gauge |
go_memstats_lookups_total | Total number of pointer lookups | cumulative |
go_memstats_mallocs_total | Total number of mallocs | cumulative |
go_memstats_mcache_inuse_bytes | Number of bytes in use by mcache structures | gauge |
go_memstats_mcache_sys_bytes | Number of bytes used for mcache structures obtained from system | gauge |
go_memstats_mspan_inuse_bytes | Number of bytes in use by mspan structures | gauge |
go_memstats_mspan_sys_bytes | Number of bytes used for mspan structures obtained from system | gauge |
go_memstats_next_gc_bytes | Number of heap bytes when next garbage collection will take place | gauge |
go_memstats_other_sys_bytes | Number of bytes used for other system allocations | gauge |
go_memstats_stack_inuse_bytes | Number of bytes in use by the stack allocator | gauge |
go_memstats_stack_sys_bytes | Number of bytes obtained from system for stack allocator | gauge |
go_memstats_sys_bytes | Number of bytes obtained from system | gauge |
go_threads | Number of OS threads created | gauge |
process_cpu_seconds_total | Total user and system CPU time spent in seconds | cumulative |
process_max_fds | Maximum number of open file descriptors | gauge |
process_open_fds | Number of open file descriptors | gauge |
process_resident_memory_bytes | Resident memory size in bytes | gauge |
process_start_time_seconds | Start time of the process since unix epoch in seconds | gauge |
process_virtual_memory_bytes | Virtual memory size in bytes | gauge |
process_virtual_memory_max_bytes | Maximum amount of virtual memory available in bytes | gauge |
Notes ๐
To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure
extraMetrics
in Add additional metrics
Non-default metrics (version 4.7.0+) ๐
To emit metrics that are not default, you can add those metrics in the
generic receiver-level extraMetrics
config option. You donโt need to
add to extraMetrics
any metric derived from configuration options
that donโt appear in the list of metrics.
To see a list of metrics that will be emitted you can run
agent-status monitors
after configuring the receiver in a running
agent instance.
Troubleshooting ๐
If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.
Available to Splunk Observability Cloud customers
Submit a case in the Splunk Support Portal .
Contact Splunk Support .
Available to prospective customers and free trial users
Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.