View agent health
Use the agent dashboard to view the health and configuration states for all agents.
Before you begin
If using role-based access control, a role with the Organization edit action is required.
If using organization users and groups, the Organization RulesAdmin role is required.
Steps
Open the agent dashboard:
Northstar: From the left navigation, under Administration, select Agent management.
Contrast: From the header, select Administration and then, select Agent Management, if not already selected.
View these details:
Internal agent ID: An identification value that Contrast assigns to the deployed agent.
To copy the full ID to your clipboard, select it.
Every time an agent starts, it generates a new instance ID and combines it with the application ID to create the Internal Agent ID. For Java and .NET agents with more than one application instrumented by the same agent, you see an ID for each application instance combination.
Application: The name of the application where the Contrast agent is instrumented.
To view details about an application, select the application name.
Northstar: This action opens the Explorer.
Contrast: This action opens the Applications list.
Status: The current status of the Contrast agent.
The statuses are Online and Terminated.
An agent with a status of Terminated is no longer active and requires a restart. This status indicates that the agent has failed to send a heartbeat signal to Contrast for more than five minutes.
Condition: The state of the agent.
Overridden: Different values for a configuration setting exist and one value is taking precedence over the others. For example, the same setting could be configured in an environment variable and in the agent's configuration file.
A best practice is to remove the extra values.
Outdated: A later version of the agent exists.
Consider upgrading the agent to a later version.
Agent key: A value that authenticate the agents.
To view details about the agent key, select an agent key name.
Language: The language that the agent is using.
Version: The version of the agent.
Last active: The last time the agent sent data to Contrast.
Hostname: The hostname of the server associated with an application
By default, the server name and the hostname are the same. However, you can change the server name; you cannot change the hostname.
Server: The name of the server associated with an application.
To view details about a server, select the server link.
In some cases, a one-to-one relationship between servers and applications is not applicable:
For ephemeral servers, only one server has a status of Online, however instances for terminated servers are stored for 30 days.
If you overwrite the
server.nameoption in the agent configuration, you could have multiple online agents associated with a single server name.For Java and .NET applications, one server and agent ID could be associated with multiple applications.
Refine the Agent dashboard view
To refine the Agent dashboard view, select Filters at the top of the list.
The Filter button shows the number of selected filters.
Select one or more filters:
Status: Displays agents with the selected statuses.
Condition: Displays agents with the selected conditions.
Application: Displays agents associated with selected applications.
Enter a partial or full name in the Search box to find specific applications.
Language: Displays agents using the selected languages.
Environment: Displays agents running in the selected environments.
Hostname: Displays the hostname for selected servers.
Enter a partial or full hostname in the Search box to find specific servers.
Server: Displays agents associated with selected servers.
Enter a partial or full name in the Search box to find specific servers.
Managed by: Displays agents that you deployed with the Flex Agent or individually.
Group Agent dashboard data
To display data based on the servers, server hostnames, or applications associated with one or more agents, select Group by at the top of the list.
Select either Application or Server
The Application group shows this data:
Application: The name of the application.
Agents: The number of agents associated with the application.
Status: The agent status.
Condition: The agent state.
Agent key: The name of the authentication key associated with the agent.
Language: The language that the agent is using.
Version: The versions of the agent in use.
Last active: The last time the agent sent data to Contrast.
Server: The number of servers associated with the application.
The Server group shows this data:
Server: The name of the server.
Application: The name of the application associated with the server.
Agents: The number of agents associated with the server.
Status: The agent status.
Condition: The agent state.
Agent key: The name of the authentication key associated with the agent.
Language: The language that the agent is using.
Version: The versions of the agent in use.
Last active: The last time the agent sent data to Contrast.
The Hostname group shows this data:
Internal agent ID: An identification value that Contrast assigns to the deployed agent.
To copy the full ID to your clipboard, select it.
Every time an agent starts, it generates a new instance ID and combines it with the application ID to create the Internal Agent ID. For Java and .NET agents with more than one application instrumented by the same agent, you see an ID for each application instance combination.
Application: The name of the application.
Hostname: The host name for the server.
Status: The agent status.
Condition: The agent state.
Language: The language that the agent is using.
Version: The versions of the agent in use.
Last active: The last time the agent sent data to Contrast.
Server: The name of the server.
View agent, application, and server details::
To view agent details, select an internal agent ID.
The agent details panel shows this information:
Internal agent ID: An identification value that Contrast assigns to the deployed agent.
To copy the full ID to your clipboard, select it.
Every time an agent starts, it generates a new instance ID and combines it with the application ID to create the Internal Agent ID. For Java and .NET agents with more than one application instrumented by the same agent, you see an ID for each application instance combination.
Application: The name of the application.
Status: The agent status.
Condition: The agent state.
Agent key: The name of the authentication key associated with the agent.
Language: The language that the agent is using.
Version: The versions of the agent in use.
Last active: The last time the agent sent data to Contrast.
Hostname: The host name for the server.
Server: The name of the server.
To view application details, select an application name.
Northstar: This action opens the Explorer.
Contrast: This action opens the Applications view.
To view server details, select a server name.
The server details panel shows this information:
Name: The name of the server.
First Seen: The first time the agents for the applications associated with the server reported activity to Contrast.
Last Seen: The last time the agents for the applications associated with the server reported activity to Contrast.
Environment: The environment where the server is deployed: Development, QA, or Production.
Applications: The applications associated with the server.