https://github.com/opennms/opennms-cortex-tss-plugin
OpenNMS Cortex Time Series Storage (TSS) Plugin
https://github.com/opennms/opennms-cortex-tss-plugin
Last synced: 3 months ago
JSON representation
OpenNMS Cortex Time Series Storage (TSS) Plugin
- Host: GitHub
- URL: https://github.com/opennms/opennms-cortex-tss-plugin
- Owner: OpenNMS
- License: other
- Created: 2020-05-22T15:53:03.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-18T20:07:57.000Z (11 months ago)
- Last Synced: 2025-07-18T22:58:17.494Z (11 months ago)
- Language: Java
- Size: 566 KB
- Stars: 5
- Watchers: 22
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OpenNMS Cortex Plugin [](https://circleci.com/gh/OpenNMS/opennms-cortex-tss-plugin)
This plugin exposes an implementation of the [TimeSeriesStorage](https://github.com/OpenNMS/opennms-integration-api/blob/v0.4.1/api/src/main/java/org/opennms/integration/api/v1/timeseries/TimeSeriesStorage.java#L40) interface that converts metrics to a Prometheus model and delegates writes & reads to [Cortex](https://cortexmetrics.io/).
## Usage
Start Cortex - see https://cortexmetrics.io/docs/getting-started/
You can also download:
https://github.com/opennms-forge/stack-play/tree/master/standalone-cortex-minimal
and start with
`docker-compose up`
Build and install the plugin into your local Maven repository using:
```
mvn clean install
```
Enable the TSS and configure:
```
echo 'org.opennms.timeseries.strategy=integration
org.opennms.timeseries.tin.metatags.tag.node=${node:label}
org.opennms.timeseries.tin.metatags.tag.location=${node:location}
org.opennms.timeseries.tin.metatags.tag.geohash=${node:geohash}
org.opennms.timeseries.tin.metatags.tag.ifDescr=${interface:if-description}' >> ${OPENNMS_HOME}/etc/opennms.properties.d/cortex.properties
```
From the OpenNMS Karaf shell:
```
feature:repo-add mvn:org.opennms.plugins.timeseries/cortex-karaf-features/1.0.0-SNAPSHOT/xml
feature:install opennms-plugins-cortex-tss
```
Configure (you can omit that if you use the default values):
```
config:edit org.opennms.plugins.tss.cortex
property-set writeUrl http://localhost:9009/api/prom/push
property-set readUrl http://localhost:9009/prometheus/api/v1
property-set maxConcurrentHttpConnections 100
property-set writeTimeoutInMs 1000
property-set readTimeoutInMs 1000
property-set metricCacheSize 1000
property-set externalTagsCacheSize 1000
property-set bulkheadMaxWaitDurationInMs 9223372036854775807
config:update
```
Update automatically:
```
bundle:watch *
```
## Cortex tips
### View the ring
http://localhost:9009/ring
### View internal metrics
http://localhost:9009/metrics