github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/influxWriteData.yaml (about)

     1  metadata:
     2    name: influxWriteData
     3    description: Writes metrics to influxdb
     4    longDescription: |
     5      In this step, the metrics are written to the timeseries database [InfluxDB](https://www.influxdata.com/time-series-platform/influxdb/)
     6  spec:
     7    inputs:
     8      secrets:
     9        - name: influxAuthTokenId
    10          description: Influxdb token for authentication to the InfluxDB. In 1.8 version use 'username:password' instead.
    11          type: jenkins
    12      params:
    13        - name: serverUrl
    14          type: string
    15          description: Base URL to the InfluxDB server
    16          scope:
    17            - PARAMETERS
    18            - STAGES
    19            - STEPS
    20            - GENERAL
    21          mandatory: true
    22        - name: authToken
    23          type: string
    24          description: Token to authenticate to the Influxdb
    25          scope:
    26            - PARAMETERS
    27            - STAGES
    28            - STEPS
    29          mandatory: true
    30          secret: true
    31          resourceRef:
    32            - name: influxAuthTokenId
    33              type: secret
    34            - type: vaultSecret
    35              name: influxVaultSecretName
    36              default: influxdb
    37        - name: bucket
    38          type: string
    39          description: Name of database (1.8) or bucket (2.0)
    40          scope:
    41            - PARAMETERS
    42            - STAGES
    43            - STEPS
    44          default: "piper"
    45        - name: organization
    46          type: string
    47          description: Name of influx organization. Only for Influxdb 2.0
    48          scope:
    49            - PARAMETERS
    50            - STAGES
    51            - STEPS
    52        - name: dataMap
    53          type: string
    54          description:
    55            "Map of fields for each measurements. It has to be a JSON string.
    56            For example: {'series_1':{'field_a':11,'field_b':12},'series_2':{'field_c':21,'field_d':22}}"
    57          scope:
    58            - PARAMETERS
    59            - STAGES
    60            - STEPS
    61          mandatory: true
    62        - name: dataMapTags
    63          type: string
    64          description:
    65            "Map of tags for each measurements. It has to be a JSON string.
    66            For example: {'series_1':{'tag_a':'a','tag_b':'b'},'series_2':{'tag_c':'c','tag_d':'d'}}"
    67          scope:
    68            - PARAMETERS
    69            - STAGES
    70            - STEPS
    71          mandatory: false