Skip to main content

Onboarding

Onboarding is a guided starting point for getting data into Coralogix. Rather than searching the integrations catalog for the right entry, you select one of two routes on a single screen: connect a cloud provider account, or deploy an OpenTelemetry collector on infrastructure you run yourself.

Open it from Integrations, then Onboarding.

Onboarding is a screen inside Coralogix. If you would rather have written setup instructions tailored to your environment, operating system, language, and collector, answer the five questions in Get started with Coralogix instead.

Note

The AWS account connection is in Preview. Azure and Google Cloud accounts cannot be connected yet, so both clouds are set up one service at a time.

What you need

  • The INTEGRATIONS:READCONFIG permission to open Onboarding and its provider screens.
  • The INTEGRATIONS:DEPLOY permission to connect a cloud account or deploy monitoring.
  • To connect an AWS account, an AWS account with permission to create a CloudFormation stack.

See the permissions list for the roles each key belongs to.

Select a route

Connect a cloud account

Use this for your cloud provider's managed services and resources.

ProviderWhat it collects
AWSMetrics, logs, and resource metadata from your AWS account
AzureMetrics, logs, and resource metadata from your Azure subscription
Google CloudMetrics, logs, and resource metadata from your Google Cloud project

Each provider opens its own setup screen inside Onboarding.

Deploy an OpenTelemetry collector

Use this for your own applications, containers, and hosts. The collector instruments your services automatically, without changes to your code.

CardWhat it does
KubernetesInstall the collector in your cluster with Helm
Linux or Windows hostInstall the collector directly on a server or virtual machine
Amazon ECSDeploy the collector to your ECS cluster

All three open the matching integration in the catalog, carrying a link back to Onboarding. See Return to Onboarding.

Set up AWS

There are two ways to send AWS data to Coralogix: connect the whole account once, or set up one service at a time.

Connect your AWS account

Connect the account once, and Coralogix finds your resources so you select which services, regions, and metrics to collect rather than configuring each one by hand.

Before connecting, select how Coralogix provisions the AWS resources it needs.

Provisioning modeWhat it means
AutomaticCoralogix creates and updates the AWS resources it needs whenever your configuration changes.
ManualYou create the AWS resources yourself with Terraform, and apply your Terraform again after every configuration change.
1.
Start the connection

Select a provisioning mode, then select Connect.

2.
Create the CloudFormation stack

Select Open AWS console. The console opens with the stack already filled in. Select Create stack there, then return to Coralogix and select I've created the stack.

The stack creates the IAM role Coralogix uses to read your AWS resources.

3.
Enter your account details

Copy these from the stack you just created: Account name, Role ARN, an optional External ID for cross-account access, and the Resource Explorer aggregator region.

4.
Create the account

Select Create account.

Resource discovery starts after the account is connected, and can take time. You review what was found, and deploy monitoring per service and region, on the Cloud Accounts page.

What the account connection covers

The connection does not collect everything in your AWS account. The AWS screen states its current scope, so you know what still needs setting up by hand.

Included in this connectionDetail
CloudWatch metrics: optimizedUp to 10 minutes delay, cost-optimized.
CloudWatch metrics: fastNo delay, real-time data. Streamed through Metric Streams and Firehose.
Cloud resource metadataA live inventory in Infrastructure Explorer.
Not included yetWhere to get it
CloudWatch logsSet up per service below
Lambda logs and tracesSet up per service below

Optimized and fast are the two collection tiers you assign per metric when you deploy monitoring. For what each tier costs and how quickly it deploys, see performance tiers.

Set up a single AWS service

You configure AWS yourself, one service at a time. Use this for anything the account connection does not cover yet, including logs.

ServiceWhat it sends
AWS CloudTrail via S3Account activity logs, read from an S3 bucket.
AWS KinesisLogs and events streamed from Kinesis Data Streams.
AWS S3 Log CollectionAny log files stored in your S3 buckets.
AWS VPC Flow Logs via S3Network traffic logs for your VPCs, subnets, and network interfaces.
AWS CloudWatch Logs via FirehoseCloudWatch log groups, streamed through Firehose.

Set up Azure or Google Cloud

Both clouds work the same way today: you send data one service at a time, and an account-level connection is planned.

The Connect your Azure account and Connect your Google Cloud account cards are marked Coming soon. Each lists what the connection will cover — Azure Monitor or Cloud Monitoring metrics, and cloud resource metadata — and marks both as available per service below, because you can already collect them through the individual integrations.

Under Set up a single service, Azure offers ARM - Blob Storage, Azure Infrastructure Explorer, and Azure Metrics. Google Cloud offers GCP Infrastructure Explorer, GCP Logs, GCP Metrics, and GCP Traces. The Infrastructure Explorer integration on either cloud is what populates your resource inventory in Infrastructure Explorer.

Selecting a card opens that integration in the catalog, where you complete the setup.

Return to Onboarding

Service and collector cards open that integration's page directly, and Browse all integrations opens the full catalog. Both add ?from=onboarding to the URL, and arriving that way puts a Back to onboarding link on the page, so a guided setup has a way back instead of stranding you in the catalog.

Troubleshooting

What you seeWhat to do
Couldn't load services on a provider screenThe catalog did not respond. Refresh the page to try again.
No services yet on a provider screenNo individual integrations are published for that provider right now. Use Browse all integrations to check the full catalog.
The AWS account is not listed after you create itRefresh the Cloud Accounts page. Resource discovery also runs after the account connects, so services appear before their resources do.
A permission error mentions an AWS Organizations service control policyThe policy attached to the account, organizational unit, or root is blocking a permission the CloudFormation role needs. Update it in AWS Organizations — a service control policy block overrides the IAM role.

Next steps

Review the resources Coralogix discovered and deploy monitoring per service: Cloud Accounts.

Last updated on