Giter VIP home page Giter VIP logo

ttn-exporter's Introduction

Prometheus exporter for The Things Network

This collects data from The Things Stack API and exports it via HTTP for Prometheus.

Works with:

  • The Things Network v3 Community edition - tested, default
  • Things Industries - untested
  • self-hosted Things Stack instances - untested

Badges

Release Software License Build status Go Doc Conventional Commits

Quick start

To run the exporter:

export TTN_API_KEY=<key>
./ttn_exporter

If you want to use Docker:

docker run -p 9981:9981 -e TTN_API_KEY=<key> ghcr.io/juusujanar/ttn-exporter:v1.0.4

Help on flags:

./ttn_exporter --help

Usage

API keys

To use this exporter, you need to generate an API key and grant it the following rights:

  • List the gateways the organization is a collaborator of - required when consuming organization gateways
  • View gateway status - to get gateway status and metrics

TTN URL

Specify custom URLs for which Things Stack instance to use using the --ttn.uri flag. Exporter defaults to Things Network Community Edition in Europe (eu1.cloud.thethings.network). For example, if you want to use enterprise Things Industries,

TTN_API_KEY=<key> ttn_exporter --ttn.uri="https://<tenant>.<region>.cloud.thethings.industries/"

Docker

To run the exporter as a Docker container, run:

docker run -p 9981:9981 -e TTN_API_KEY=<key> ghcr.io/juusujanar/ttn-exporter:v1.0.4 --ttn.uri="https://<tenant>.<region>.cloud.thethings.industries/"

ttn-exporter's People

Contributors

dependabot[bot] avatar juusujanar avatar renovate[bot] avatar

Watchers

 avatar  avatar

ttn-exporter's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

dockerfile
Dockerfile
  • golang 1.23
github-actions
.github/workflows/golangci-lint.yml
  • actions/checkout v4
  • golangci/golangci-lint-action v6
.github/workflows/release.yml
  • actions/checkout v4
  • actions/setup-go v5
  • docker/login-action v3
  • docker/login-action v3
  • goreleaser/goreleaser-action v6
  • ubuntu 22.04
.github/workflows/test.yml
  • actions/checkout v4
  • actions/setup-go v5
gomod
go.mod
  • go 1.20
  • github.com/alecthomas/kingpin/v2 v2.4.0
  • github.com/go-kit/log v0.2.1
  • github.com/prometheus/client_golang v1.20.1
  • github.com/prometheus/common v0.55.0
  • github.com/prometheus/exporter-toolkit v0.11.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.