https://github.com/mccann-hub/service-agent
Custom Axios client for microservice debugging and tracing. Automatically injects correlation IDs, trace IDs, and span IDs into HTTP headers, enhancing observability across distributed systems
https://github.com/mccann-hub/service-agent
axios deno deno-module microservices typescript typescript-library
Last synced: 4 months ago
JSON representation
Custom Axios client for microservice debugging and tracing. Automatically injects correlation IDs, trace IDs, and span IDs into HTTP headers, enhancing observability across distributed systems
- Host: GitHub
- URL: https://github.com/mccann-hub/service-agent
- Owner: McCann-Hub
- Created: 2024-11-22T15:08:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-27T14:06:39.000Z (over 1 year ago)
- Last Synced: 2025-04-09T06:20:23.320Z (about 1 year ago)
- Topics: axios, deno, deno-module, microservices, typescript, typescript-library
- Language: TypeScript
- Homepage:
- Size: 176 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Service Agent
A custom Axios client for streamlined debugging and tracing in distributed microservices environments. This library facilitates the propagation of correlation IDs, trace IDs, and span IDs across service boundaries, enhancing observability and troubleshooting.
## Features
- Automatic injection of `correlationId`, `traceId`, and `spanId` into HTTP headers.
- Customizable span ID generation for service-to-service calls.
- Robust logging for request and response lifecycles.
- Extendable via custom Axios configurations.
## Installation
```bash
npm install @mccann-hub/service-agent
```
or
```bash
yarn add @mccann-hub/service-agent
```
## Usage
### Basic Setup
```typescript
import serviceAgent from "@mccann-hub/service-agent";
const req = {
correlationId: "abc123",
traceId: "xyz789",
logger: console,
};
const client = serviceAgent()(req);
client
.get("/endpoint")
.then((response) => console.log(response.data))
.catch((err) => console.error(err));
```
### Custom Configurations
```typescript
const client = serviceAgent({
correlationIdHeader: "X-Correlation-Id",
traceIdHeader: "X-Trace-Id",
spanIdHeader: "X-Span-Id",
axiosConfig: {
baseURL: "https://api.example.com",
timeout: 5000,
},
})(req);
```
### Integration with Express
```typescript
import express from "express";
import serviceAgent from "@mccann-hub/service-agent";
const app = express();
app.get("/api", (req, res) => {
const client = serviceAgent()(req);
client
.get("/other-service")
.then((data) => res.send(data))
.catch((err) => res.status(500).send(err.message));
});
```
## API
### serviceAgent(config?)
- **config (optional):** Configuration object:
- **correlationIdHeader:** Header name for correlation IDs (default: X-Correlation-Id).
- **traceIdHeader:** Header name for trace IDs (default: X-Request-Id).
- **spanIdHeader:** Header name for span IDs (default: X-svc2svc-Id).
- **generator:** Function to generate span IDs.
- **axiosConfig:** Custom Axios configuration.
Returns a function that accepts an IRequest object and returns an Axios instance.