Skip to main content

Node.js and Sumo Logic

Tracetest is a testing tool based on OpenTelemetry that allows you to test your distributed application. It allows you to use data from distributed traces generated by OpenTelemetry to validate and assert if your application has the desired behavior defined by your test definitions.

Sumo Logic is a cloud-based machine data analytics company focusing on security, operations and BI use-cases. It provides log management and analytics services that use machine-generated big data.

Node.js App with Sumo Logic, OpenTelemetry, and Tracetest

This is a simple quick start on how to configure a Node.js app to use OpenTelemetry instrumentation with traces and Tracetest for enhancing your E2E and integration tests with trace-based testing. The infrastructure will use Sumo Logic as the trace data store, and the Sumo Logic distribution of OpenTelemetry Collector to receive traces from the Node.js app and send them to Sumo Logic.

Prerequisites

Tracetest Account:

Sumo Logic Account:

Docker: Have Docker and Docker Compose installed on your machine.

Run This Quckstart Example

The example below is provided as part of the Tracetest project. You can download and run the example by following these steps:

Clone the Tracetest project and go to the Sumo Logic Node.js Quickstart:

git clone https://github.com/kubeshop/tracetest
cd tracetest/examples/quick-start-sumologic-nodejs

Follow these instructions to run the quick start:

  1. Copy the .env.template file to .env.
  2. Log into the Tracetest app.
  3. Fill out the token and API key details by editing your .env file. You can find these values in the Settings area for your environment.
  4. Run docker compose up -d.
  5. This example is configured to use the Sumo Logic Tracing Backend. Ensure the environment you're using to run this example is configured to use the Sumo Logic Tracing Backend by clicking on Settings, Tracing Backend, Sumo Logic, Save. Or, use the CLI as explained below.
  6. Run tests from the Tracetest Web UI by accessing the app with the URL http://app:8080/.

Follow along with the sections below for an in detail breakdown of what the example you just ran did and how it works.

Project Structure

The project contains Tracetest Agent, Sumo Logic OpenTelemetry Collector, and a Node.js app.

The docker-compose.yaml file in the root directory of the quick start runs the Node.js app and the Tracetest Agent setup.

Configuring the Node.js App

The Node.js app is a simple Express app, contained in the app.js file.

Configure the .env like shown below.

TRACETEST_API_KEY="<YOUR_TRACETEST_API_KEY>"

The OpenTelemetry tracing is contained in the tracing.otel.grpc.js or tracing.otel.http.js files.

Choosing the tracing.otel.grpc.js file will send traces to Sumo Logic OpenTelemetry Collector's GRPC endpoint.

Enabling the tracer is done by preloading the trace file. As seen in the package.json.

"scripts": {
"app-with-grpc-tracer": "node -r ./tracing.otel.grpc.js app.js",
},

Configuring Sumo Logic

Configure the .env like shown below.

SUMOLOGIC_INSTALLATION_TOKEN="<YOUR_SUMOLOGIC_INSTALLATION_TOKEN>"
Configure Sumo Logic Installation Token

View the Sumo Logic docs here to learn more about installation tokens.

Configure Sumo Logic as a Tracing Backend:

---
type: DataStore
spec:
name: Sumo Logic
type: sumologic
sumologic:
# The URL will differ based on your location. View this
# docs page to figure out which URL you need:
# https://help.sumologic.com/docs/api/getting-started/#which-endpoint-should-i-should-use
url: "https://api.sumologic.com/api/"
# Create your ID and Key under Administration > Security > Access Keys
# in your Sumo Logic account:
# https://help.sumologic.com/docs/manage/security/access-keys/#create-your-access-key
accessID: "your-access-id"
accessKey: "your-access-key"
Configure Sumo Logic API and Access
tracetest config -t <YOUR_API_TOKEN>
tracetest apply datastore -f ./tracetest.datastore.yaml

Run the Node.js App and Sumo Logic OpenTelemetry Collector with Docker Compose

The docker-compose.yaml file and Dockerfile in the root directory are for the Node.js app.

And, the docker-compose.yaml contains one service for the Node.js app, one service for the Sumo Logic OpenTelemetry Collector, and one service for Tracetest Agent.

The collector.config.yaml configures the OpenTelemetry Collector. It receives traces via either grpc or http. Then, exports them to Sumo Logic via the Sumo Logic extension and an installation_token.

To start it, run this command:

docker compose up -d

This will start the Node.js app and Sumo Logic OpenTelemetry Collector and send the traces to Sumo Logic.

Run Tracetest Tests

  1. Open Tracetest
  2. Configure Sumo Logic as a tracing backend if you have not already as explained above.
  3. Start creating tests! Make sure to use the http://app:8080/ URL in your test creation.
  4. To trigger tests in the CLI, first install the CLI, configure it, and run a test. From the root of the quick start directory, run:
tracetest configure -t <YOUR_API_TOKEN>
tracetest run test -f ./test-api.yaml

Learn More

Feel free to check out our examples in GitHub and join our Slack Community for more info!