Tutorials

Tutorials

Event & Version Tags

event version tags

‘Tags’ is the best way for you to understand your version status at a glance, integrate with your deployment pipeline, and get your latest build status. Whether it’s new exceptions, higher error ratios, or new broken flows – we got you covered

Tags can be anything, they can be received automatically from your pipelines or inserted manually, they can be a new version, a new big customer, or an attribution point to that day when your dev team had sangria at lunch. 

Simply go to “Tags” on your top menu, integrate into your pipeline or manually add an event tag, and get a full status in the context of your event.

1) High-level status: change in triggered Anomalies, change in triggered Alerts, change in error volume, change in newly introduced errors, and the change in high severity logs ratio since the tag time and in comparison to the corresponding timeframe in the comparison tag.

2) Error Volume: number of errors since the tag.

3) Alert Volume: number of alerts since the tag, grouped by alert name.

4) Error Anomalies: errors that arrived more than their normal ratio (as learned by Coralogix) since the tag.

5) Newly introduced Logs: logs that appeared on your system for the first time after the tag/build.

6) Custom widgets: pre-defined Coralogix visualizations based on your own version quality criteria. Learn more about widgets here.

7) Top error Templates: Top errors since the tag (maximum appearances).

Integrate with your deployment pipelines: 

1) Bitbucket
2) TFS
3) GitLab
4) Heroku Pipelines
5) Add version tag using cURL

For any of the following integration below you should include headers with the following properties:

  1. ‘Content-Type: application/json’
  2. ‘Authorization: Bearer <YOUR_Alerts & Rules & Tags API Key>’

The API key can be taken from your team settings –> Account –> API Access –>Alerts & Rules & Tags API Key

1. Integrate Coralogix with BitBucket:

Coralogix supports integration with bitbucket webhooks, use webhooks to inform Coralogix when a new build is issued. 
1) log in to bitbucket using your user credentials.
2) Go to your overview page and then go to settings.
3) In settings go to webhooks.
4) Add a new webhook.

a) Add a title (for example: “Coralogix builds”)

b) Add URL: https://webapi.coralogix.com/api/v1/external/tags/bitbucket?application=YOUR_APPLICATION_NAME&subsystem=YOUR_SUBSYSTEM_NAME&name=YOUR_TAG_NAME

c) Application – your desired application name – please use an identical name to correspond with your logs application name. – must

d) Subsystem – your desired system name – please use an identical name to correspond with your logs subsystem name, you can add more than 1 subsystem name separated by a comma. 

5) Select trigger
Select build status updated:
coralogix integration to bitbucket
6) Click Save.

2. Integrate Coralogix TFS:

1) Sign in to TFS using your user credentials.
2) Select your team project.
3) Click settings.
4) Go to Service hooks.
5) Click add new service hooks.
6) Select “Web Hooks”
7) Select “Build Completed” as the trigger.
8) Select Build Status “Succeeded”  and click Next.
a) You may choose any filter as you desire.
9) Add URL: https://webapi.coralogix.com/api/v1/external/tfs?application=YOUR_APPLICATION_NAME&subsystem=YOUR_SUBSYSTEM_NAME&name=YOUR_TAG_NAME

a) Application – your desired application name – please use an identical name to correspond with your logs application name. – must

b) Subsystem – your desired system name – please use an identical name to correspond with your logs subsystem name. you can add more than 1 subsystem name separated by a comma. 

coralogix integration to TFS
10) Click finish 

3. Integrate Coralogix GitLab:

1) Log in to GitLab using your Credentials.
2) Go to your project page.
3) Go to Settings -> Integrations
4)Add url: https://webapi.coralogix.com/api/v1/external/gitlab?application=YOUR_APPLICATION_NAME&subsystem=YOUR_SUBSYSTEM_NAME&name=YOUR_TAG_NAME

a) Application – your desired application name – please use an identical name to correspond with your logs application name. – must

b) Subsystem – your desired system name – please use an identical name to correspond with your logs subsystem name. you can add more than 1 subsystem name separated by a comma. 

5) Select PipeLine events.
coralogix integration to Gitlab
6) Click Save.

4. Integrate Coralogix Heroku Pipelines:

Simply provision the Coralogix add-on and in case you use Heroku pipelines, Coralogix will integrate into it automatically and you will start seeing your Heroku builds on the Coralogix log timelines and in the Tags display.

5. Add version tag using cURL

You can add version tags per Application and Subsystem using cURL:

URL: https://webapi.coralogix.com/api/v1/external/tags
Method: POST
Body Schema:
{
  "iconUrl": string,
  "name": string,
  "timestamp": date type (JavaScript date string or epoch milliseconds)
  "application": string[]
  "subsystem": string[]
}
Application: your application name.
Subsystem: your subsystem names. You can input more than one subsystem name, use comma delimiter ‘,’  between subsystems names.
Name: your version tag name.
Timestamp: tag timestamp, if a timestamp is not supplied, the current timestamp will be applied.
IconUrl: tag picture (optional): Use a URL (URL encoded) to a valid image file that you have uploaded to a public repository (png, jpeg, SVG). Max size 50KB.
Note – when applying spaces in the URL use: %20 instead.
Example (GET):
curl --location --request GET 'http://webapi.coralogix.com/api/v1/external/tags/add?key=<YOUR_Alerts & Rules & Tags API Key>&application=Application_Name,Application_Name2&subsystem=Subsystem1,Subsystem2,Subsystem3&name=MyFirstTag&timestamp=2020-06-23:09:00:00&iconUrl=your_icon_url' \
--data-raw ''
Example (POST):
curl --location --request POST 'https://webapi.coralogix.com/api/v1/external/tags' \
--header 'Authorization: Bearer <YOUR_Alerts & Rules & Tags API Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "timestamp": 1617793927675,
    "name": "test tag",
    "application": ["prd", "dev"],
    "subsystem": ["app", "mobile"],
    "iconUrl": "my-avatar.png"
}'

Start solving your production issues faster

Let's talk about how Coralogix can help you

Managed, scaled, and compliant monitoring, built for CI/CD

Get a demo

No credit card required

© 2021 Copyright Coralogix. All rights reserved.

Get a personalized demo

Jump on a call with one of our experts and get a live personalized demonstration