Agent Management
Agent catalog
By default, the agent catalog view shows high-level information about every agent:
- Agent name - Often derived from the server on which the agent is hosted
- Agent status - Live, if active connection is maintained with the agent
- OS - The OS of the host server
- Agent type - OTel collector type (e.g., agent, gateway, cluster-collector, etc.)
- Pipelines -The telemetry pipelines set up in the OTel config for that agent (e.g., logs, metrics, traces)
- Cluster - The name of the cluster in which this agent is deployed
- Agent version
- Agent CPU usage
- Agent memory usage
- Records refused by the receiver on this agent
- Send failures by the exporter on the agent
Search
Users can use the search bar at the top of the page to perform key value searching (using the Lucene syntax), or use free text searching to search for the presence of a string in all fields attached to a given agent. For example, searching for gateway alone will find all agents with an agent type of gateway, but also will find any agents with ‘gateway’ in the name.
Note
Free text searching can yield some noise, so the simplest experience is often to know the field you wish to query.
Investigating a single agent
By selecting one of your agents, a modal window expands indicating a number of dimensions.
- Overview - A high level reading of the live status of your agent, CPU, memory and any receiver/exporter errors.
- Details - A summary of the resource’s identity, metadata, configuration, and labels from available data sources.
- Relationships - Significant infrastructure relationships that this agent has. For example, the server on which it is deployed.
- Metrics - Explorable metrics that this collector is publishing through OpAMP.
- Configuration - The OpenTelemetry configuration for this agent
Overview
The Overview section provides high-level graphs, to give an “at a glance” view of the health of your collector.
At the top, the Live Status view gives aggregate views of four golden signals for your agent. Below, in the Key Metrics section, is a time-series view of the same data.
Details
The Details section aggregates data from available sources, including OpenTelemetry, Kubernetes, and cloud providers, to provide a comprehensive view of how the resource is defined and configured in your environment.
Relationships
The Relationships view connects the agent with the infrastructure on which it depends. This is useful when investigating an issue with an agent, to understand if the underlying infrastructure is the root cause.
The following tabs are available:
- Pods
- Containers
- Namespaces
- Clusters
- Storage
Selecting one of the resources in the tabs will open a separate view for that node, allowing users to drill down into the details of that specific piece of infrastructure. For example, as above, selecting the node will open up that node in a separate view, that can be further explored.
Metrics
The metrics pane gives users the ability to freely explore the metrics produced by the agent. This can be useful for debugging and root cause analysis, where the root cause may be revealed by a more obscure metric.
From this view, users can expand and explore specific views, to better see what is going on.
Users are also able to search and filter using the search bar at the top of the view. This will search for metrics containing the inputted string in the name of the metric. For example, searching for “consumer” narrows down to only consumer related metrics.
If users wish to understand the underlying query that is pulling a metric, they can do so using the icon at the top right of the window for that given metric:
Selecting this button will open a pane that highlights the underlying query.
Configuration
The Configuration view gives an explorable view of the OpenTelemetry configuration for this particular agent. From this view, users can dive into the specific fields that have been set, that may be contributing to any misbehaviours or performance issues that an agent may be experiencing.
Users can search for a specific value within the configuration.
Using the icons to the right of the search bar, they can copy the entire view to the clipboard or download the configuration as a YAML file.
Support
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to reach out to us via our in-app chat or by sending us an email at support@coralogix.com.