Epsagon Documentation

Welcome to the Epsagon Documentation. You'll find comprehensive guides and documentation to help you start working with our product as quickly as possible. Let's jump right in!

Get Started


Epsagon's integration to Kubernetes clusters provides:

  • Performance metrics, insights, and alerts across your whole cluster.
  • Detailed mappings of clusters, nodes, pods, containers, and deployments to verify their health.
  • Containers' logs.


Integrate multiple Kubernetes clusters

With Epsagon, you can integrate as many Kubernetes clusters that you want. Just follow the deployment process on each cluster that you wish to integrate.


To add a Kubernetes cluster to Epsagon to monitor its resources run this command in your bash terminal:

curl -L -o epsagon_k8s.sh https://k8s.epsagon.com && chmod +x epsagon_k8s.sh && source ./epsagon_k8s.sh <token>

The script will:

  • Look at your kubectl configuration and add an Epsagon Cluster Role attached to a Service Account to every cluster. This allows it to read resources from the cluster (pods, deployments, etc). If no endpoint is found in your kubectl config, you will be asked to provide it (for example: https://my-cluster.com).
  • Send the Service Account token to Epsagon to allow for remote cluster monitoring.

You can obtain your token from the settings page.

To validate the integration, you can go to the Kubernetes screen to see the cluster's information and metrics.


Cluster access

If you are trying to integrate a cluster behind a firewall (or VPC), make sure to allow inbound connections from these IP addresses (port 443):

Correlate traces and logs

Epsagon automatically correlates traces and logs, so that you can view the logs written in the context of a specific span, without having to manually search in your logs or manually inject span IDs in your logs.

To enable trace to log correlation

  1. Trace your containers. Log correlation is supported for Node.js, Python, and Java.
  2. Send your logs to AWS CloudWatch by setting up FluentD as a DeamonSet. Make sure that the configmap is named cluster-info, and is in the namespace amazon-cloudwatch.

To view logs of a trace, open a trace, select a node in the graph, and click Show Logs.


Rancher Support

Create a token under API & Keys in Rancher.
This token should be used to allow Epsagon access to your cluster.
Use this token when the Epsagon cluster integration script.

No data appears on the Kubernetes dashboard

When no data appears in the dashboard, Epsagon cannot access your Kubernetes cluster.
If you are using a tool that implements custom authentication to your cluster (like Rancher), please contact our support.

If your cluster is not accessible to the internet, make sure to whitelist the following IPs (port 443):

Supported Versions

Kubernetes (EKS, AKS, GKE and Self-Hosted) v1.14 - v1.18

Removing the integration

To remove the integration, run the following command:

kubectl delete namespace epsagon-monitoring

Updated 4 months ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.