New announcements for Serverless, Network, RUM, and more from Dash! New announcements from Dash!

Stardog

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

Get metrics from the Stardog service in real time to:

  • Visualize and monitor Stardog states
  • Be notified about Stardog failovers and events.

Setup

The Stardog check is NOT included in the Datadog Agent package.

Installation

If you are using Agent v6.8+ follow the instructions below to install the Stardog check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior v6.8 or the Docker Agent:

  1. Install the developer toolkit.
  2. Clone the integrations-extras repository:

    git clone https://github.com/DataDog/integrations-extras.git.
    
  3. Update your ddev config with the integrations-extras/ path:

    ddev config set extras ./integrations-extras
    
  4. To build the stardog package, run:

    ddev -e release build stardog
    
  5. Download and launch the Datadog Agent.

  6. Run the following command to install the integrations wheel with the Agent:

    datadog-agent integration install -w <PATH_OF_STARDOG_ARTIFACT_>/<STARDOG_ARTIFACT_NAME>.whl
    
  7. Configure your integration like any other packaged integration.

Configuration

  1. Edit the stardog.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Stardog metrics. See the sample stardog.d/conf.yaml for all available configuration options.

  2. Restart the Agent

Validation

Run the Agent’s status subcommand and look for stardog under the Checks section.

Data Collected

Metrics

stardog.dbms.mem.mapped.max
(gauge)
The maximum amount of memory used for memory mapping
Shown as byte
stardog.dbms.mem.mapped.used
(gauge)
The number of bytes used in the memory map
Shown as byte
stardog.dbms.memory.direct.reserve
(gauge)
The amount of direct memory reserved
Shown as byte
stardog.system.cpu.usage
(gauge)
CPU usage
Shown as byte
stardog.system.uptime
(gauge)
The number of seconds that Stardog has been running
Shown as second
stardog.dbms.memory.heap.reserve
(gauge)
The heap memory reserved
Shown as byte
stardog.dbms.memory.managed.direct
(gauge)
Managed direct memory
Shown as byte
stardog.dbms.memory.managed.heap
(gauge)
Managed heap memory
Shown as byte
stardog.dbms.mem.heap.used
(gauge)
The amount of heap memory used
Shown as byte
stardog.dbms.mem.heap.max
(gauge)
The maximum heap size
Shown as byte
stardog.dbms.mem.direct.buffer.used
(gauge)
The amount of direct memory used
Shown as byte
stardog.dbms.mem.direct.buffer.max
(gauge)
The maximum amount of direct memory that can be used
Shown as byte
stardog.dbms.mem.direct.pool.max
(gauge)
The maximum size of the direct memory pool
Shown as byte
stardog.dbms.mem.direct.pool.used
(gauge)
The amount of memory used from the direct pool
Shown as byte
stardog.dbms.mem.direct.max
(gauge)
The maximum amount of direct memory that can be used
Shown as byte
stardog.dbms.mem.direct.used
(gauge)
The amount of direct memory used
Shown as byte
stardog.databases.system.planCache.ratio
(gauge)
Plan cache ration
Shown as percent
stardog.databases.system.planCache.size
(gauge)
Plan cache size
Shown as byte
stardog.databases.txns.openTransactions
(gauge)
The number of open transations on a given database
Shown as unit
stardog.databases.queries.running
(gauge)
The number of currently running queries on a given database
Shown as unit
stardog.databases.openConnections
(gauge)
The number of open connections on a given database
Shown as unit
stardog.databases.txns.speed.count
(gauge)
The current transaction speed on the database
Shown as unit
stardog.databases.txns.speed.max
(gauge)
The fastest transaction speed achieved
Shown as unit
stardog.databases.txns.speed.mean
(gauge)
The average transaction speed on the database
Shown as unit
stardog.databases.txns.speed.min
(gauge)
The slowest transaction speed on the database
Shown as unit
stardog.databases.txns.speed.p50
(gauge)
The 50th percentile transaction speed on the database
Shown as unit
stardog.databases.txns.speed.p75
(gauge)
The 75th percentile transaction speed on the database
Shown as unit
stardog.databases.txns.speed.p95
(gauge)
The 95th percentile transaction speed on the database
Shown as unit
stardog.databases.txns.speed.p98
(gauge)
The 98th percentile transaction speed on the database
Shown as unit
stardog.databases.txns.speed.p99
(gauge)
The 99th percentile transaction speed on the database
Shown as unit
stardog.databases.txns.speed.p999
(gauge)
The 99.9th percentile transaction speed on the database
Shown as unit
stardog.databases.txns.speed.stddev
(gauge)
The stardard deviation for the transaction speed
Shown as unit
stardog.databases.txns.speed.m15_rate
(gauge)

Shown as unit
stardog.databases.txns.speed.m1_rate
(gauge)

Shown as unit
stardog.databases.txns.speed.m5_rate
(gauge)

Shown as unit
stardog.databases.txns.speed.mean_rate
(gauge)

Shown as unit
stardog.databases.queries.speed.count
(gauge)
The current query speed on the database
Shown as unit
stardog.databases.queries.speed.max
(gauge)
The fastest query speed achieved
Shown as unit
stardog.databases.queries.speed.mean
(gauge)
The average query speed on the database
Shown as unit
stardog.databases.queries.speed.min
(gauge)
The slowest query speed on the database
Shown as unit
stardog.databases.queries.speed.p50
(gauge)
The 50th percentile query speed on the database
Shown as unit
stardog.databases.queries.speed.p75
(gauge)
The 75th percentile query speed on the database
Shown as unit
stardog.databases.queries.speed.p95
(gauge)
The 95th percentile query speed on the database
Shown as unit
stardog.databases.queries.speed.p98
(gauge)
The 98th percentile query speed on the database
Shown as unit
stardog.databases.queries.speed.p99
(gauge)
The 99th percentile query speed on the database
Shown as unit
stardog.databases.queries.speed.p999
(gauge)
The 99.9th percentile query speed on the database
Shown as unit
stardog.databases.queries.speed.stddev
(gauge)
The stardard deviation for the query speed
Shown as unit
stardog.databases.queries.speed.m15_rate
(gauge)

Shown as unit
stardog.databases.queries.speed.m1_rate
(gauge)

Shown as unit
stardog.databases.queries.speed.m5_rate
(gauge)

Shown as unit
stardog.databases.queries.speed.mean_rate
(gauge)

Shown as unit

Events

The Stardog check does not include any events.

Service Checks

The Stardog check does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.


Mistake in the docs? Feel free to contribute!