openziti_exporter

README

OpenZiti exporter

Prometheus exporter for collecting OpenZiti Management Edge API information, written in Go with pluggable metric collectors.

Installation and Usage

The openziti_exporter listens on HTTP port 10004 by default. See the --help output for more options.

Helm

A helm chart called prometheus-openziti-exporter is available at enthus-it

    helm repo add enthus-it https://enthus-it.github.io/helm-charts
    helm repo update
    helm show values enthus-it/prometheus-openziti-exporter
    helm install helm install prometheus-openziti-exporter enthus-it/prometheus-openziti-exporter

OpenZiti Management Edge API configuration

This exporter consumes the OpenZiti Management Edge API, the OpenZiti Fabric API, and needs to be configured accordingly.

Flag / Environment Variable	Description
--ziti.mgt.api / ZITI_MGMT_API	OpenZiti API basepath URL.
--ziti.admin.username / ZITI_ADMIN_USER	OpenZiti Admin Username.
--ziti.admin.password / ZITI_ADMIN_PASSWORD	OpenZiti API Admin Password.

NOTE: If the User is not an Administrator, then no information will be returned by the API.

Collectors

There is varying support for collectors on each operating system. The tables below list all existing collectors and the supported systems.

Collectors are enabled by providing a --collector.<name> flag. Collectors that are enabled by default can be disabled by providing a --no-collector.<name> flag. To enable only some specific collector(s), use --collector.disable-defaults --collector.<name> ....

Enabled by default

Name	Description
fabric_links	Exposes OpenZiti Fabric Links from the Fabric API.
identities	Exposes OpenZiti Identities from the Edge Management API.
routers	Exposes OpenZiti Edge-Routers from the Edge Management API.

Disabled by default

None

Development building and running

Prerequisites:

• Go compiler
• Access to the OpenZiti Edge Management API

Building:

    git clone https://github.com/enthus-it/openziti_exporter.git
    cd openziti_exporter
    make build
    ./openziti_exporter <flags>

To see all available configuration flags:

    ./openziti_exporter -h

Running tests

    make test

TLS endpoint

EXPERIMENTAL The exporter supports TLS via a new web configuration file.

    ./openziti_exporter --web.config.file=web-config.yml

See the exporter-toolkit https package for more details.