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

Setting Application Names

Distributed applications are complex, and can become complicated. Lots of services, stages, and names that dynamically change over time.

Epsagon is here to help you encapsulate all of this under a single organizational entity - an application.

What is an Epsagon Application?

An application is a group of services and resources. For example:

retail-store-prod application

The following retail-store-prod application aggregates together our Spring, Kafka, Lambda, DynamoDB, S3, and Stripe resources all together.

Grouping into applications allows for easy filtering, visualizing, and alerting.

Configuring the Application Name

Configuring the application name is an easy, one-step modification. App names are defined when Epsagon is initialized within the App.

To initialize Epsagon, call the init method with your unique Token, suppling both token and appName properties.

const epsagon = require('epsagon')

epsagon.init({
    token: <EPSAGON-TOKEN>,
    appName: <APP-NAME-STAGE>
})

Once set, every call and operation that is being captured throughout this service, will belong to the same application, for example:

In this scenario, we've enable Epsagon tracing on the consumer service, and all interacted resources will belong to app-name-stage.

Choosing an application name

The simplest way of choosing an application would be {business-name}-{stage}.

In business name, you can insert the part of the application belongs to, for example - mobile-app, store, or data-pipeline. The stage can be any meaningful separation for you, in case you are having the same application, but in different stages or environments.

Good examples would be:

  • mobile-app-dev
  • store-prod
  • data-pipeline-staging

Updated 2 days ago


Setting Application Names


Suggested Edits are limited on API Reference Pages

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