> For the complete documentation index, see llms.txt.
Skip to main content

Check out Port for yourself ➜ 

Coralogix

Coralogix iconCoralogix icon
Loading version...

Port's Coralogix integration syncs APM services, SLOs, alert definitions, and cases into your context lake.

Supported resources External link iconServiceSLOAlert definitionCase

Prerequisites​

Create an API key​

  1. In Coralogix, create a personal or team API key.
  2. Grant the key the permissions below. The Read-Only User role includes all of them.
KindPermission
ServiceMETRICS.DATA-API#HIGH:READDATA
SLOSLO:READCONFIG
Alert definitionALERTS:READCONFIG
CaseCASES:READ

Choose the API URL​

Use either the API URL for your region, such as https://api.eu2.coralogix.com, or the team URL you open in the browser, such as https://myteam.app.eu2.coralogix.com. The integration derives the API host from the team URL.

Region hosts are listed in the Coralogix domain documentation.

Setup​

Choose one of the following installation methods. Not sure which method is right for your use case? Check the available installation methods.

Choose method

Configuration​

Port integrations use a YAML mapping block to ingest data from the third-party API into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

Default mapping configuration​

This is the default mapping configuration for this integration:

Default mapping configuration (click to expand)
deleteDependentEntities: true
createMissingRelatedEntities: false
resources:
- kind: service
selector:
query: 'true'
lookback: 30d
window: 1h
metricsSource: auto
port:
entity:
mappings:
identifier: .serviceName
title: .serviceName
blueprint: '"coralogixService"'
properties:
environments: .environments
clusters: .clusters
namespaces: .namespaces
requestsPerSecond: .requestsPerSecond
errorRatePct: .errorRatePct
p95LatencyMs: .p95LatencyMs
metricsWindow: .window
metricsSource: .metricsSource
link: .__teamUrl
- kind: slo
selector:
query: 'true'
includeStatus: true
port:
entity:
mappings:
identifier: .id
title: .name
blueprint: '"coralogixSlo"'
properties:
description: .description
targetPct: .targetThresholdPercentage
timeFrame: '{"SLO_TIME_FRAME_1_DAY": "1 day", "SLO_TIME_FRAME_7_DAYS": "7 days", "SLO_TIME_FRAME_14_DAYS": "14 days", "SLO_TIME_FRAME_21_DAYS": "21 days", "SLO_TIME_FRAME_28_DAYS": "28 days", "SLO_TIME_FRAME_30_DAYS": "30 days"}[.sloTimeFrame]'
sliType: 'if .apmSli then "apm" elif .windowBasedMetricSli then "window" else "request" end'
compliancePct: 'if .__status.lowestCompliance != null then .__status.lowestCompliance * 100 else null end'
remainingErrorBudgetPct: 'if .__status.lowestRemainingErrorBudget != null then .__status.lowestRemainingErrorBudget * 100 else null end'
completeWindow: .__status.effectiveWindowCompleteData
labels: .labels
creator: .creator
createdAt: .createTime
link: .__teamUrl + "/slo/" + .id + "/overview"
relations:
service: .labels.service // .apmSli.services[0]
- kind: alert-definition
selector:
query: 'true'
port:
entity:
mappings:
identifier: .id
title: .alertDefProperties.name
blueprint: '"coralogixAlertDefinition"'
properties:
description: .alertDefProperties.description
type: '.alertDefProperties.type | sub("ALERT_DEF_TYPE_"; "") | sub("_OR_UNSPECIFIED$"; "")'
priority: '.alertDefProperties.priority | sub("ALERT_DEF_PRIORITY_"; "") | sub("_OR_UNSPECIFIED$"; "")'
enabled: .alertDefProperties.enabled
status: '(.status // "ALERT_DEF_STATUS_UNSPECIFIED") | sub("ALERT_DEF_STATUS_"; "")'
groupByKeys: .alertDefProperties.groupByKeys
hasNotificationTarget: '((.alertDefProperties.notificationGroup.webhooks // []) + (.alertDefProperties.notificationGroup.destinations // []) | length) > 0'
labels: .alertDefProperties.entityLabels
lastTriggeredAt: .lastTriggeredTime
link: .__teamUrl + "/alerts/" + .id
relations:
service: .alertDefProperties.entityLabels.service
- kind: case
selector:
query: 'true'
daysBack: 30
port:
entity:
mappings:
identifier: .id
title: .readableId + " " + .title
blueprint: '"coralogixCase"'
properties:
readableId: .readableId
status: .status | sub("CASE_STATUS_"; "")
priority: .priority | sub("CASE_PRIORITY_"; "")
priorityOverridden: '(.priorityDetails.user // .priorityDetails.override) != null'
category: .category | sub("CASE_CATEGORY_"; "")
assignee: .assignee.email
createdAt: .createTime
acknowledgedAt: .acknowledgeTime
resolvedAt: .resolutionDetails.resolveTime
resolutionReason: .resolutionDetails.reason
labels: '(.labels // []) | map({(.key): .value}) | add'
link: .__teamUrl + "/cases?id=" + .readableId
relations:
alertDefinitions: '[.caseIndicators.alertIndicators[]?.alertId] | unique'
service: '[.impactedEntities[]?.apmService.name // empty][0] // ((.groupings // []) | map(select(.key == "service_name")) | .[0].value)'

Monitoring and sync status​

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.

Mapping and selectors per resource​

Use the explorer below to view the blueprint, the default mapping, a sample payload, and the resulting Port entity for each resource.

Sync behavior​

Services​

Services come from span metrics through the Metrics API. The APM service catalog has no public list API.

A service is included when it emitted any span during lookback. Request rate, error rate, and P95 latency are measured on entry spans (server and consumer) over window. A service that is idle in that window is still synced, with zero requests.

metricsSource: auto checks, in order, Coralogix span metrics (calls_total), compact span metrics (compact_calls_total), and the OpenTelemetry spanmetrics connector (traces_span_metrics_calls_total). Compact span metrics only carry the cluster, so environments and namespaces stay empty for that source.

Incremental sync​

Cases also sync on the incremental interval. That run lists cases created since the last cursor, and it does not look further back than daysBack. It updates those cases and leaves the rest of the catalog until the next full resync. A case created before the cursor, then acknowledged or resolved, is updated on the next full resync. Services, SLOs, and alert definitions are included in the full resync only.

To view and test the mapping against live API responses, use the jq playground in your connectors page.