Jenkins Plugin

This Coralogix Jenkins plugin adds support for sending console logs & stats and pushes tags to Coralogix.
NOTE: The Coralogix plugin will work on Jenkins version 2.277.2 and above, if your Jenkins isn’t in the mentioned versions, you may try our Curl commands located further in the doc.

Installation

• Download the hpi file from GitHub releases
• Put the hpi file in the directory $JENKINS_HOME/plugins
• Restart Jenkins

Configuration

Go to Manage Jenkins, open Configure system, find Coralogix section and configure your account Send-Your-Data API key for sending system/audit/security logs and metrics (take note that Send system log wont be checked since it’s not currently supported):

You can configure as many keys as you want.

Notes:

• An example of a Custom Coralogix Endpoint is private.coralogix.com.
• If your Coralogix domain ends with a suffix other than ‘.com’, overwrite the Coralogix API endpoint value by going to the Advanced section and inserting:

https://<cx_domain>

Credentials

Before usage you need to create Jenkins credentials with Coralogix Send-Your-Data API key for your team, navigate to  Manage Jenkins > Manage Credentials and click on Jenkins under Stores scoped to Jenkins.
You will be welcomed by this table:

Next, create a new credential of kind: Coralogix API key, this keys’ value is taken from: Data flow > API keys copy the “Alerts, Rules and Tags API Key” (the first on the list) and insert it into the field.
This will allow us to use the “push tags” function, since it will allow creation of a tag each time there is a build in the pipe.

To push Tags you need to go under your config and click Add build step.

Select Push Tags to Coralogix and select the Tags key from your credentials.

Usage

This plugin supports sending build logs and tags pushing both for Freestyle project and Pipelines.

Send logs

Send your build logs to Coralogix.

Freestyle project
Just check the Send build logs to Coralogix, select Private Key, and provide Application name:

Pipeline

This is the Groovy implementation:

pipeline {
    agent any
    stages {
        stage('Test') {
            steps {
                echo "Hello world!"
            }
        }
    }
    post {
        always {
            coralogixSend privateKeyCredentialId: 'coralogix-production',
                          application: 'MyApp',
                          subsystem: "${env.JOB_NAME}",
                          splitLogs: true
        }
    }
}

Curl

It’s possible to use Curl command to create a log. Select the Coralogix [2] Logs Endpoint associated with your Coralogix domain.

curl --location --request POST '<endpoint>' \
--header 'private_key: <privatekey>' \
--header 'Content-Type: application/json' \
--data-raw '{"applicationName": "prd", "subsystemName": "app", "text": "hello world", "severity": "3"}'

Note: “text”, “severity” are optional fields.

Send metrics

Send your pipeline metrics to Coralogix.

Pipeline

This is the Groovy implementation:

pipeline {
    agent any
    stages {
        stage('Test') {
            steps {
                echo "Hello world!"
            }
        }
    }
    post {
        always {
            coralogixMetricsSend privateKeyCredentialId: 'coralogix-production',
                                 application: 'MyApp',
                                 subsystem: "${env.JOB_NAME}",
                                 splitStages: false
        }
    }
}

Push tag

Push version tag to Coralogix.

Freestyle project
Add build step Push Coralogix tag and configure:

• Private Key – your Coralogix account Send-Your-Data API key
• Tag name – version tag name
• Application name – your application name
• Subsystem names – your subsystem names
• Icon(optional) – your own tag picture

Pipeline

This is the Groovy representation of Push Coralogix tag build step:

pipeline {
    agent any
    stages {
        stage('Test') {
            steps {
                echo "Hello world!"
            }
        }
    }
    post {
        success {
            coralogixTag apiKeyCredentialId: 'coralogix-production-api',
                         tag: '1.0.0',
                         applications: [
                            [name: 'MyApp']
                         ],
                         subsystems: [
                            [name: 'staging'],
                            [name: 'production']
                         ],
                         icon: 'https://raw.githubusercontent.com/coralogix/jenkins-coralogix-plugin/master/docs/images/logo.svg'
        }
    }
}

Curl

It’s possible to use Curl command to create a tag, choose the right Endpoint, add the “APIkey” and run the command below.
NOTE: “timestamp” and “iconUrl” are optional fields.

curl --location --request POST '<yourCoralogixEndpoint>' \
--header 'Authorization: Bearer <APIKey>' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "test tag",
"timestamp": <currentTimeinMilliseconds>
"application": ["prd", "dev"],
"subsystem": ["app", "mobile"],
"iconUrl": "<iconUrl>"
}'

License

The Coralogix Plugin is licensed under the Apache 2.0 License.