One or more Required Agents does not exist

Description

This Alert is monitoring for missing Required Agents. It is triggered when there are no Agent instances, for Agent Types which require at least one Agent.

Alert Details

Alert ID: 034d0230-bd3b-4c50-b17d-7b7fdd85ccd0

Tags: Each tag should follow "key:value" format.

  • FeatureDomain:Agents
  • PageType:SavedSearch
  • PageID:a537815d-891b-4743-9353-9f43223c72e8
  • CreatedBy:Relativity
  • Resolution

Metric/Log/Trace Details

Metric Name: relsvr.agent.exists

Metric Description: Whether the agent exists

  • A value of 0 indicates that the Agent does not exist.
  • A value of 1 indicates that at least one Agent does exist.

Metric Attributes:

Attribute Name Description Value
labels.application_name Environment Administration & Operations
labels.name Name of the metric Required Agent does not exist
labels.relsvr_system System Name Agents
labels.relsvr_subsystem Subsystem Name The name of the Agent Type which is missing its Required Agent
labels.relsvr_agent_required Whether the agent is required Set to 1 to indicate that the agent is required
labels.relsvr_agent_type_name Agent Type Name The name of the Agent Type which is missing its Required Agent
labels.relsvr_agent_type_guid Agent Type Guid The guid of the Agent Type which is missing its Required Agent
labels.message Message describes the issue A sentence containing information about the Agent Type of the Required Agent that does or does not exist

Rule details

Alert Condition Description:

Name Value Description
Rule Type Elastic Query
Data View metrics-*
Filter Query relsvr.agent.exists : 0 and labels.relsvr_agent_required : 1 If the agent did not exist in the last 35 seconds
Group Count Number of Required Agents which did not exist
Threshold > 0 If the count is greater than 0, alert triggers
Time Window Last 35 sec Verified data for last 35 seconds
Frequency 5 min Checks every 5 minutes

Technical Details:

  • The Alert will trigger if there is a record in the Agent Type table whose MinInstanceEnvironment field is set to 1, but there are no existing Agents of that type in the Agents Tab of Relativity.
  • The Case Manager will never trigger this alert, because it has been deprecated.
  • The Telemetry Metrics Transmission Agent will trigger this alert if there are no existing Agents with that Agent Type.
  • The Data Grid Audit Manager will trigger this alert if there are no existing Agents with that Agent Type.
  • The implementation identifies these specific Agent Types by their Guid. The Guids used are shown in the table below.
Agent Type Guid
Case Manager 894462EF-395F-4527-A51B-8D328D229030
Telemetry Metrics Transmission Agent 20546D6-6C68-4879-AF26-09BE6F9862B7
Data Grid Audit Manager A2599262-F8D7-4263-8BAC-0CEA694728BC

Requires User Intervention

  • Yes: alert immediately
    • Min time before the alert is active/inactive: 5 min

Kibana search link

Host Heartbeat alert should not be in active state.