Maverics observability (Local development)

The Orchestrator emits telemetry data from the running process by using OpenTelemetry.

To configure your Maverics instance to emit telemetry, see Telemetry.

Metrics

Metrics are numerically-based observations (counters, totals, etc.)

All metrics emit both their value, and a list of shared resource attributes, described in the Shared resource attributes section.

Orchestrator metrics

The following custom metrics are emitted by the orchestrator:

Active Requests

Active Requests (simultaneous) is described here

Attributes:

• http.request.method HTTP request method (string)

• server.address Name of the local HTTP server that received the request (string)

• server.port local HTTP server port (int)

• url.scheme http or https (string)

For example:

{
    __name__="http_server_active_requests",
    ..., 
    service_name="io.strata.maverics", 
    service_version="0.18.14", 
    ...,
    http_request_method="GET",
    server_address="maverics.sonarsystems.com", 
    server_port="7474",
    url_scheme="http",
...
}

Server Latency (request duration)

Server Latency (aka request duration) is described here

Attributes:

• http.request.method HTTP request method (string)

• server.address Name of the local HTTP server that received the request (string)

• server.port local HTTP server port (int)

• url.scheme http or https (string)

For example:

{
    __name__="http_server_duration",
    ..., 
    service_name="io.strata.maverics", 
    service_version="0.18.14", 
    ...,
    http_request_method="GET",
    server_address="maverics.sonarsystems.com", 
    server_port="7474",
    url_scheme="http",
...
}

Request Count

Request count is a running total of all requests received by the Orchestrator.

Attributes:

• status_code HTTP response status (int)

For example:

{
    __name__="http_server_request_count",
    ..., 
    service_name="io.strata.maverics", 
    service_version="0.18.14", 
    ...,
    http_request_method="GET",
    server_address="maverics.sonarsystems.com", 
    server_port="7474",
    url_scheme="http",
...
}

Session Count

The Orchestrator Session Count metric displays the number of known sessions.

For example:

{
    __name__="io_strata_maverics_sessions", 
    ..., 
    service_name="io.strata.maverics", 
    service_version="0.18.14", 
...
}

{{< callout type="info" >}}
Sessions are removed from this count only when a user with an expired session attempts to navigate to a protected URL.
{{< /callout >}}

OTLP metrics

The Orchestrator also uses built-in metrics that are defined within OTLP.

To review the OTLP documentation on the semantics of these metrics, see the OpenTelemetry repo.

For more complete information on each of these metrics, see the OTLP system metrics documentation.

Runtime metrics

Monitoring the metric runtime.uptime is the best way to ensure your Orchestrator is up and running. The value should continually increment, while the Orchestrator is up and functioning.

Host metrics

These metrics are only emitted on Linux and Windows systems.

HTTP Metrics

The following HTTP Metrics are collected and emitted by the Orchestrator:

Shared resource attributes

For every metric above, the Orchestrator also adds the following shared resource attributes:

For example, a complete runtime.uptime metric with resource attributes may look like the following:

runtime_uptime{
    container_id="45d64ce11347", 
    exported_job="io.strata.maverics", 
    host_name="localhost.localdomain", 
    instance="otelcol:9464", 
    job="otel", 
    os_description="Fedora Linux 35 (Workstation Edition) (Linux localhost.localdomain 5.17.7-200.fc35.x86_64 #1 SMP PREEMPT Thu May 12 14:56:48 UTC 2022 x86_64)", 
    os_type="linux", 
    process_command_args="["bin/maverics_linux_amd64","-v","-config","../maverics.yaml"]", 
    process_executable_name="maverics_linux_amd64", 
    process_executable_path="/etc/bin/maverics_linux_amd64", 
    process_owner="user1", 
    process_pid="12345", 
    process_runtime_description="go version go1.19 linux/amd64",
    process_runtime_name="go", 
    process_runtime_version="go1.19", 
    service_instance_id="e83daeb0-0dee-4d80-a3f6-5f9d4cb9ff3", 
    service_name="io.strata.maverics", 
    service_version="0.20.4"
}, 123456