Skip to main content

Overview

The Stellar Core Prometheus Exporter reads metrics exposed by the stellar-core daemon and exposes them in prometheus format.

Configuration

Optional config can be provided using CLI arguments or environment variables.

Supported configuration options:

  • --stellar-core-address - address of monitored stellar-core. Defaults to http://127.0.0.1:11626. Can also be set using STELLAR_CORE_ADDRESS environment variable
  • --port - listening port. Defaults to 9473. Can also be set using PORT environment variable

Grafana dashboard

Grafana can be used to visualise data. Example dashboards are shipped with this code. Latest versions is also available on grafana.com

Please refer to the documentation for details.

Docker image

Included Dockerfile uses apt package to deploy the exporter. Example build command:

docker build -t stellar-core-prometheus-exporter:latest .

Installing from pypi

To download/test package in pypi you can use venv:

python3 -m venv venv
. venv/bin/activate

Install:

python3 -m pip install stellar_core_prometheus_exporter

Run:

./venv/bin/stellar-core-prometheus-exporter

Releasing new version

  • ensure you bumped version number in setup.py. PyPi does not allow version reuse
  • build new package:
python3 setup.py sdist bdist_wheel
  • push to testpypi:
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
  • test by installing the package (see above). If all good release:
python3 -m twine upload dist/*

Metadata

Release files for stellar-core-prometheus-exporter 0.10.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for stellar-core-prometheus-exporter 0.10.6
File Interpreter ABI Platform
stellar_core_prometheus_exporter-0.10.6-py3-none-any.whl Python 3 none any Details

Release files / stellar_core_prometheus_exporter-0.10.6-py3-none-any.whl

Download URL stellar_core_prometheus_exporter-0.10.6-py3-none-any.whl
Size 12.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ff9c0a78c67437b820541ac321c564f29274d01057b45ed325ed37fe7eb88a30
BLAKE2b-256 checksum
How to use checksums
01328ba1bff90bf96b4bf69a0f5ba9ec73c8db450f9e3d812b49df52c11ee7a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.2

Security for stellar-core-prometheus-exporter 0.10.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page