> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

InfluxDB Plugin

View this plugin on the Plugins site

influxDbPublisher: Publish build data to InfluxDB

  • selectedTarget
    InfluxDB target to send data to. Targets have to be configured in the global Jenkins settings.
    • Type: String
  • customData (optional)
    • Type: java.util.Map<java.lang.String, java.lang.Object>
  • customDataMap (optional)
    • Type: java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.Object>>
  • customDataMapTags (optional)
    • Type: java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>
  • customDataTags (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • customPrefix (optional)
    A custom prefix that gets prepended to the job name, for example to prevent several 'master' metrics for different jobs in multi branch pipeline jobs.
    • Type: String
  • customProjectName (optional)
    Sets a custom value for the InfluxDB 'project_name' tag key, that overrides the default, which is the job name.

    Useful to easily group metrics for different jobs in multi branch pipeline jobs.

    • Type: String
  • jenkinsEnvParameterField (optional)
    Custom field set that will be added to the default measurement 'jenkins_data', configured as key-value pairs (one per line, in Java Properties file format).

    Current build parameters and/or environment variables can be used in the form of ${PARAM}

    • KEY=${PARAM}
    • KEY=PREFIX_${PARAM}_SUFFIX
    • KEY=VALUE
    • Type: String
  • jenkinsEnvParameterTag (optional)
    Custom tag set that will be added to all measurements, configured as key-value pairs (one per line, in Java Properties file format).

    Current build parameters and/or environment variables can be used in the form of ${PARAM}

    • KEY=${PARAM}
    • KEY=PREFIX_${PARAM}_SUFFIX
    • KEY=VALUE
    • Type: String
  • measurementName (optional)
    • Type: String
  • replaceDashWithUnderscore (optional)
    • Type: boolean

step([$class: 'InfluxDbPublisher']): Publish build data to InfluxDB

  • target
    • Type: String
  • customData (optional)
    • Type: java.util.Map<java.lang.String, java.lang.Object>
  • customDataMap (optional)
    • Type: java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.Object>>
  • customDataMapTags (optional)
    • Type: java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>
  • customDataTags (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • customPrefix (optional)
    A custom prefix that gets prepended to the job name, for example to prevent several 'master' metrics for different jobs in multi branch pipeline jobs.
    • Type: String
  • customProjectName (optional)
    Sets a custom value for the InfluxDB 'project_name' tag key, that overrides the default, which is the job name.

    Useful to easily group metrics for different jobs in multi branch pipeline jobs.

    • Type: String
  • jenkinsEnvParameterField (optional)
    Custom field set that will be added to the default measurement 'jenkins_data', configured as key-value pairs (one per line, in Java Properties file format).

    Current build parameters and/or environment variables can be used in the form of ${PARAM}

    • KEY=${PARAM}
    • KEY=PREFIX_${PARAM}_SUFFIX
    • KEY=VALUE
    • Type: String
  • jenkinsEnvParameterTag (optional)
    Custom tag set that will be added to all measurements, configured as key-value pairs (one per line, in Java Properties file format).

    Current build parameters and/or environment variables can be used in the form of ${PARAM}

    • KEY=${PARAM}
    • KEY=PREFIX_${PARAM}_SUFFIX
    • KEY=VALUE
    • Type: String
  • measurementName (optional)
    • Type: String
  • selectedTarget (optional)
    InfluxDB target to send data to. Targets have to be configured in the global Jenkins settings.
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.