1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
sap-jenkins-library/resources/metadata/influxWriteData.yaml
Philipp Stehle f9f0cbfd33
enforce that step metadata yaml file is called <step>.yaml (#3226)
Co-authored-by: Philipp Stehle <philipp.stehle@sap.com>
2021-11-15 14:20:20 +01:00

72 lines
2.1 KiB
YAML

metadata:
name: influxWriteData
description: Writes metrics to influxdb
longDescription: |
In this step, the metrics are written to the timeseries database [InfluxDB](https://www.influxdata.com/time-series-platform/influxdb/)
spec:
inputs:
secrets:
- name: influxAuthTokenId
description: Influxdb token for authentication to the InfluxDB. In 1.8 version use 'username:password' instead.
type: jenkins
params:
- name: serverUrl
type: string
description: Base URL to the InfluxDB server
scope:
- PARAMETERS
- STAGES
- STEPS
- GENERAL
mandatory: true
- name: authToken
type: string
description: Token to authenticate to the Influxdb
scope:
- PARAMETERS
- STAGES
- STEPS
mandatory: true
secret: true
resourceRef:
- name: influxAuthTokenId
type: secret
- type: vaultSecret
name: influxVaultSecretName
default: influxdb
- name: bucket
type: string
description: Name of database (1.8) or bucket (2.0)
scope:
- PARAMETERS
- STAGES
- STEPS
default: "piper"
- name: organization
type: string
description: Name of influx organization. Only for Influxdb 2.0
scope:
- PARAMETERS
- STAGES
- STEPS
- name: dataMap
type: string
description:
"Map of fields for each measurements. It has to be a JSON string.
For example: {'series_1':{'field_a':11,'field_b':12},'series_2':{'field_c':21,'field_d':22}}"
scope:
- PARAMETERS
- STAGES
- STEPS
mandatory: true
- name: dataMapTags
type: string
description:
"Map of tags for each measurements. It has to be a JSON string.
For example: {'series_1':{'tag_a':'a','tag_b':'b'},'series_2':{'tag_c':'c','tag_d':'d'}}"
scope:
- PARAMETERS
- STAGES
- STEPS
mandatory: false