https://github.com/saidsef/tracing-node

Opentelemetry Wrapper for Tracing Node Applications
https://github.com/saidsef/tracing-node

monitoring observability opentelemetry telemetry tracing tracing-applications tracing-collector tracing-node wrapper

Last synced: about 1 month ago
JSON representation

Opentelemetry Wrapper for Tracing Node Applications

• Host: GitHub
• URL: https://github.com/saidsef/tracing-node
• Owner: saidsef
• License: apache-2.0
• Created: 2023-07-04T16:48:37.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-03T06:08:36.000Z (6 months ago)
• Last Synced: 2024-12-06T21:54:15.912Z (6 months ago)
• Topics: monitoring, observability, opentelemetry, telemetry, tracing, tracing-applications, tracing-collector, tracing-node, wrapper
• Language: JavaScript
• Homepage:
• Size: 417 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Opentelemetry Wrapper for Tracing Node Applications 

[![CI](https://github.com/saidsef/tracing-node/actions/workflows/pr.yml/badge.svg)](#Instalation)

[![Release](https://github.com/saidsef/tracing-node/actions/workflows/release.yml/badge.svg)](#Instalation)

![GitHub issues](https://img.shields.io/github/issues/saidsef/tracing-node)

![npm](https://img.shields.io/npm/v/%40saidsef%2Ftracing-node) ![npm](https://img.shields.io/npm/dt/%40saidsef/tracing-node)

![GitHub release(latest by date)](https://img.shields.io/github/v/release/saidsef/tracing-node)

![Commits](https://img.shields.io/github/commits-since/saidsef/tracing-node/latest.svg)

Get telemetry for your app in less than 3 minutes!

A wrapper around opentelemetry and set of instrumentation applications. This is to make instrumentation (more) idempotent.

## Prerequisites

- NodeJS

- ...

- Profit!

## Instalation

```

npm install @saidsef/tracing-node --save

```

## Usage

You can set required params via env variables or function:

Env vars:

```

CONTAINER_NAME || HOSTNAME

ENDPOINT

SERVICE_NAME

```

Function args

```

const { setupTracing } = require('@saidsef/tracing-node');

setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'});

```

```

import { setupTracing } from '@saidsef/tracing-node';

setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'});

```

### Required Parameters are

| Name | Type | Description|

|----- | ---- | ------------- |

| hostname | string | container / pod hostname | 

| serviceName | string | service / application name |

| url | string | tracing endpoint i.e. `://:` |

| enableFsInstrumentation | boolean | enable FS instrumentation, default `false` |

| enableDnsInstrumentation | boolean | enable DNS instrumentation, default `false` |

## Source

Our latest and greatest source of `tracing-node` can be found on [GitHub](https://github.com/saidsef/tracing-nodec/fork). Fork us!

## Contributing

We would :heart: you to contribute by making a [pull request](https://github.com/saidsef/tracing-node/pulls).

Please read the official [Contribution Guide](./CONTRIBUTING.md) for more information on how you can contribute.