Metadata-Version: 2.4
Name: stackstate-openmetrics
Version: 0.0.1
Summary: The Openmetrics check
Home-page: https://github.com/StackVista/stackstate-agent-integrations
Author: StackState
Author-email: info@stackstate.com
License: BSD-3-Clause
Keywords: stackstate agent openmetrics check
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Monitoring
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
Requires-Dist: stackstate-checks-base
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

# Agent Check: Openmetrics

## Overview

Extract custom metrics from any OpenMetrics endpoints.

**Note:** All the metrics retrieved by this integration are considered as custom metrics.

## Setup

### Installation

The Openmetrics check is included in the [StackState Agent][2] package, so you do not
need to install anything else on your server.

### Configuration

1. Edit the `openmetrics.d/conf.yaml` file, in the `conf.d/` folder at the root of your
   Agent's configuration directory to start collecting your openmetrics performance data.
   See the [sample openmetrics.d/conf.yaml][2] for all available configuration options.

2. Restart the Agent

## Data Collected

### Metrics

All metrics collected by the OpenMetrics check are forwarded to StackState as custom metrics.

### Service Checks

Openmetrics does not include any service checks.

### Events

Openmetrics does not include any events.

### Topology

Openmetrics does not include any topology.

[1]: **LINK_TO_INTEGERATION_SITE**
[2]: https://github.com/StackVista/stackstate-agent-integrations/blob/master/openmetrics/stackstate_checks/openmetrics/data/conf.yaml.example
