Telemetry Smoke Test

This test is used to verify that system usage metrics can be transmitted to Relativity. For information on telemetry configuration see Telemetry and metrics.

For Server 9.7 and later, telemetry can be verified by the following procedure:

  1. Disable the telemetry agent.
  2. Logout and log back in to Relativity.
  3. Enable the telemetry agent.
  4. After 15 seconds, refresh the page and observe the agent message:
  • Success Condition- telemetry agent message is immediately updated to "Started." and after several seconds or minutes "Completed."
  • Failure Condition- telemetry agent message is immediately updated to "Received error during transmission (retrying 1/10): An error occurred while sending the request." and after several minutes, "Transmission failed after 10 retries"

For Server versions earlier than 9.7, it is necessary to have access to SQL server to verify telemetry:

  1. Ensure that the telemetry agent is enabled.
  2. In SQL server, add a record to the metrics table using the following script:
    3. DECLARE @ID nvarchar(50) = convert(nvarchar(50), NEWID())
DECLARE @SmokeBucketName nvarchar(500) = 'SmokeTest.Telemetry'
DECLARE @Date nvarchar(50) = Convert (nvarchar(25), CONVERT (date, GETDATE(), 126)) + 'T00:00:00.0000000-00:00'
DECLARE @SmokeObjectValue nvarchar(MAX) = '{"MetricID":0,"ID":"'+ @ID +'","Timestamp":"'+ @Date +'","Bucket":"'+ @SmokeBucketName +'","WorkspaceGuid":"00000000-0000-0000-0000-000000000000","WorkflowID":"","MetricTarget":1,"MetricType":4,"Value":"Test"}'
INSERT INTO [EDDSMetrics].[eddsdbo].[Metrics] ([Bucket], [Object]) VALUES (@SmokeBucketName, @SmokeObjectValue)
SELECT TOP 1 [Bucket] FROM [EDDSMetrics].[eddsdbo].[Metrics] WHERE [Bucket] = @SmokeBucketName
  3. Wait 30 seconds for the telemetry agent is execute.
  4. Query the metrics table and verify that there are no records:
SELECT TOP 1 [Bucket] FROM [EDDSMetrics].[eddsdbo].[Metrics] WHERE [Bucket] = 'SmokeTest.Telemetry'
  • Success Condition- database has no records after being queried the second time.
  • Failure Condition- the inserted record is not removed from the metrics table within the expected time.