Skip to content
This repository has been archived by the owner on Dec 5, 2023. It is now read-only.

Latest commit

 

History

History
57 lines (29 loc) · 3.3 KB

README.md

File metadata and controls

57 lines (29 loc) · 3.3 KB

Note: This repo is being archived in favor of the same repo under the Splunk Github account from which it was forked. Changes have been commited and merged into that repo.

Splunk DLT Connector Libraries

This repository hosts a set of common, shared libraries used in TypeScript-based data connectors by the Splunk DLT team. Libraries are written in TypeScript and published as NPM libraries in the @splunkdlt NPM organization. All libraries are designed to be used in Node.js and are not tested or expected to work in the browser.

Packages

Generic helpers around asynchronous tasks, parallel execution, retrying and aborting them.

Simple typescript cache library with simple LRU implementation.

Wrapper around debug creating a set of structured debug loggers with a common name prefix.

Common eslint config for DLT connect packages

Flexible client library for Splunk HTTP Event Collector (HEC) with support for sending metrics and events, batching, compression, keep-alives and retries.

A set of helpers to perform an orderly shutdown of a collector process.

Utility to help scrape metrics from apps exposing prometheus-style metrics endpoints.

A helper to collect stats (internal metrics) of a node process to send to Splunk.

Docker Images

A simple docker image that uses the @splunkdlt/prometheus-scraper package to periodically scrape metrics from a prometheus endpoint and forwards them to a Splunk HTTP Event Collector.

Contributing

Thank you for considering to contribute to Splunk DLT Connect Libraries! Please read the contribution guidelines and the developer guide to get started.