BPCDetails-Exporter
|
|
Mit dem BPCDetails-Exporter kann man Details über die Laufzeiten der im BPC hinterlegten API-Keys und Indices exportieren.
Konfiguration
Der BPCDetails-Exporter ist ein Plugin auf Basis des JavaPlugin-Exporters. Um ihn zu betreiben, muss er in der Konfiguration des JavaPlugin-Exporters aktiviert werden.
Die Konfiguration für den BPCDetails-Exporter befindet sich in der Datei vimon/config/javaplugin_exporter/javaplugins/bpcdetails_exporter.yml.
Hier wird die URL des BPCs konfiguriert und es können weitere TLS-Einstellungen vorgenommen werden:
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|
Für den produktiven Betrieb wird empfohlen, das LogLevel auf INFO zu setzen. |
Des Weiteren muss das neue Plugin in der Prometheus-Konfiguration bekannt gemacht werden. In der folgenden Beispielkonfiguration werden alle VIMON-Exporter über einen HAProxy aggregiert (daher Port 9443), für den Proxy muss die Konfiguration dann ebenfalls angepasst werden.
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'Metriken
Das Plugin exportiert folgende Metriken:
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
