BPCDetails-Exporter

Linux

Windows

The BPCDetails-Exporter can be used to export details about the runtimes of the API keys and indices stored in the BPC.

Configuration

The BPCDetails-Exporter is a plugin based on the JavaPlugin-Exporter. In order to operate it, it must be activated in the configuration of the JavaPlugin-Exporter.

The configuration for the BPCDetails-Exporter can be found in the file vimon/config/javaplugin_exporter/javaplugins/bpcdetails_exporter.yml.

The URL of the BPC is configured here and further TLS settings can be made:

logLevel: INFO # ALL, CONFIG, FINE, FINER, FINEST, INFO, SEVERE, WARNING, OFF

hostURL: http://localhost:8181        #URL of the BPC
apiKey: XXX                           #API-Key with access to the BPC
tls_config:
  skipCertVerification: false         #Skip https certificate validation
  useCustomCert: false                #Use a custom certificate for the connection
  pathToCustomCert: /path/to/cert

For productive operation, it is recommended to set the LogLevel to INFO.

Furthermore, the new plugin must be made known in the Prometheus configuration. In the following example configuration, all VIMON exporters are aggregated via an HAProxy (therefore Port 9443), the configuration must then also be adapted for the proxy.

prometheus-config

scrape_configs:
  - job_name: 'BPCDetails_Exporter'
    scheme: https
    metrics_path: /bpcdetails_exporter/metrics
    tls_config:
      ca_file: ../tls/vimon.crt
      cert_file: ../tls/vimon.pem
      key_file: ../tls/vimon.pem
      insecure_skip_verify: true
    static_configs:
      - targets: ['127.0.0.1:9443']
        labels:
          app: 'bpc'
          project: 'vimon'
          part: 'details'
          stage: 'prod'
          job: 'bpcDetails'
          host: 'example.virtimo.net'

Metrics

The plugin exports the following metrics:

VIMON_jpe_BPCDetailsExporter_success 1 #0 error
VIMON_jpe_BPCDetailsExporter_apikey_expire{name="inubit 8.1 API Key", expireDate="2026-02-19T12:00:16.115Z", id="API-123"} 23050005 #Expire date in seconds
VIMON_jpe_BPCDetailsExporter_index_numberOfReplicas{alias="bpc-logs", id="bpc-logs_1"} 1
VIMON_jpe_BPCDetailsExporter_index_numberOfShards{alias="bpc-logs", id="bpc-logs_1"} 3
VIMON_jpe_BPCDetailsExporter_index_docsCount{alias="bpc-logs", id="bpc-logs_1"} 612
VIMON_jpe_BPCDetailsExporter_index_storeSizeInBytes{alias="bpc-logs", id="bpc-logs_1"} 985145
VIMON_jpe_BPCDetailsExporter_index_docsDeleted{alias="bpc-logs", id="bpc-logs_1"} 0
VIMON_jpe_BPCDetailsExporter_index_health{alias="bpc-logs", id="bpc-logs_1"} 1 #2 green, 1 yellow, 0 red
VIMON_jpe_BPCDetailsExporter_index_state{alias="bpc-logs", id="bpc-logs_1"} 1 #1 open, 0 closed