Send your data to Coralogix using Prometheus Agent, a new operational mode of running Prometheus, built directly into the Prometheus binary. The agent mode optimizes the remote write use case configuring the Prometheus instance while disabling some of Prometheus’ usual features – querying and alerting.
Use agent mode to:
1. Sign up for a Coralogix account. Set up your account on the Coralogix domain corresponding to the region within which you would like your data stored.
2. Access your Coralogix private key.
3. Install and configure Prometheus Operator. Prometheus Agent collects ServiceMonitors and PodMonitors, which are enabled only when using the Prometheus Operator.
Note:
STEP 1. Create a secret private key.
Create a Kubernetes secret
for your Coralogix private key called coralogix-keys
with the value PRIVATE_KEY
.
Take this step in order to ensure that your private key remains protected and unexposed. While other methods exist for protecting this private information, we recommend creating a secret in this manner while running on a Kubernetes cluster.
Your private key, as well as the Helm chart, should be saved in the same namespace.
kubectl create secret generic coralogix-keys \\ --from-literal=PRIVATE_KEY=<private-key>
The created secret should look like this:
apiVersion: v1 data: PRIVATE_KEY: <encrypted-private-key> kind: Secret metadata: name: coralogix-keys namespace: <the-release-namespace> type: Opaque
STEP 2. Configure your Coralogix endpoints.
Using the region associated with your Coralogix domain, configure your Coralogix endpoint.
Cluster (Region) | Endpoint |
EU (Ireland) | https://ingress.coralogix.com/prometheus/v1 |
EU2 (Sweden) | https://ingress.eu2.coralogix.com/prometheus/v1 |
US | https://ingress.coralogix.us/prometheus/v1 |
APAC1 (India) | https://ingress.coralogix.in/prometheus/v1 |
APAC2 (Singapore) | https://ingress.coralogixsg.com/prometheus/v1 |
STEP 3. Add the Coralogix Helm charts repository.
Add the Coralogix Helm charts repository to the local repos list with the following command:
helm repo add coralogix-charts-virtual https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
To get the updated Helm charts from the added repository, run:
helm repo update
STEP 4. Create an override.yaml file.
Create an override.yaml file, which includes the following:
--- # override.yaml: prometheus: prometheusSpec: remoteWrite: - authorization: credentials: name: coralogix-keys key: PRIVATE_KEY name: prometheus-agent-coralogix queueConfig: capacity: 2500 maxSamplesPerSend: 1000 maxShards: 200 remoteTimeout: 120s url: <YOUR_ENDPOINT>
STEP 5. Install the chart.
helm upgrade prometheus-agent coralogix-charts-virtual/prometheus-agent-coralogix \ --install \ --namespace=<your-namespace> \ --create-namespace \ -f override.yaml
By default, the Prometheus agent uses ephemeral volumes, which is not suitable for a production environment.
For a production environment, we highly recommended defining a persistent volume to avoid data loss between restarts. This is done by using the specification available on the values file.
Note:
If you do not specify the storageClassName
, Kubernetes will use the default storage class available on the cluster.
prometheus: prometheusSpec: storageSpec: volumeClaimTemplate: spec: accessModes: ["ReadWriteOnce"] resources: requests: storage: 50Gi
Documentation | Prometheus Operator |
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].