View instrumentation
Details of the instrumentation agents across your hosts and clusters.
The Instrumentation tab enables you to track the health, configuration, and status of your agents running on different hosts and clusters in your organization.
You can filter the list by Agent type, Environment, Version, Service, or Status. Use the search bar to filter the list by cluster name or host name, which is particularly useful for large-scale environments.
Select Add filter to filter by OS type.
To save the report as a CSV file, select the Download icon. The exported file includes any currently applied filters.
Hosts view
The Hosts view within the Instrumentation tab help you monitor and manage instrumentation agents specifically running on various host machines.
Summary metrics for hosts
You can access high-level insights into your agent deployment:
-
Total agents: Displays the total count of active agents currently reporting to the platform.
-
Agent types: Indicates the number of agent types, such as Java, Node.js, .NET deployed in your environment.
-
Agents out-of-date: Count of the agents that are not on running the latest version. Select the card to view the full list.
-
Disconnected agents: Count of the agents across all hosts that are not reporting any signal within a period. The default period is 90 seconds. Select the card to view the details.
Details of agents running on hosts
The list provides a granular view of each instrumentation agent:
| Column | Description |
|---|---|
| Type | The specific language agent, such as Java, Node.js, .NET. |
| Host name | The name of the host where the agent is running. |
| Environment | The deployment environment associated with the agent. |
| Version | The specific version of the agent currently in use. Highlights the version that is out-of-date. |
| Service | The service or application associated with the agent. |
| Last status check | The timestamp of the most recent heartbeat from the agent. |
| Status |
Represents the health of the connection- whether the agent is actively communicating with the server. It has two values- Connected or Disconnected. Connected: The agent has reported a heartbeat signal within the last period. The default period is 90 seconds. Disconnected: The agent has not reported a heartbeat signal within the last period. The default period is 90 seconds. Agents that do not send a heartbeat signal within a five-minute window are automatically removed from the list. |
Select an agent from the list to view the following details:
-
agent summary
-
effective configuration of the agent. You can download or copy the environment variables.
-
associated service in Splunk APM.
Clusters view
The Clusters view within the Instrumentation tab help you monitor and manage instrumentation agents specifically organized by the cluster deployments.
Summary metrics for clusters
You can view the following cards with summary metrics:
-
Total agents: The total number of agents currently reporting.
-
Agent types: The number of different agent, such as Java, Node.js, .NET deployed across your clusters.
-
Agents out-of-date : Count of agents that are not on running the latest version. Select the card to view the full list.
-
Disconnected agents: Count of the agents across all clusters that are not reporting any signal within a period. The default period is 90 seconds. Select the card to view the details.
Details of agents running on clusters
The list provides a comprehensive snapshot of each agent:
| Column | Description |
|---|---|
| Type | The specific language agent, such as Java, Node.js, .NET. |
| Cluster Name | The specific cluster where the agent is deployed. |
| Environment | The associated deployment environment. |
| Version | The agent version. |
| Services | The service associated with the agent. |
| Last status check | The timestamp of the most recent heartbeat from the agent. |
| Status |
Represents the health of the connection- whether the agent is actively communicating with the server. It has two values- Connected or Disconnected. Connected: The agent has reported a heartbeat within the last period. The default period is 90 seconds. Disconnected: The agent has not reported a heartbeat within the last period. The default period is 90 seconds. Agents that do not send a heartbeat signal within a five-minute window are automatically removed from the list. |
Select an agent from the list to view the following details:
-
agent summary
-
effective configuration of the agent. You can download or copy the environment variables.