https://github.com/socketsomeone/nestjs-hot-shots
🐶 Hot-shots Module for Nest.js Framework
https://github.com/socketsomeone/nestjs-hot-shots
datadog hot-shots metrics nest nestjs telegraf typescript
Last synced: 8 months ago
JSON representation
🐶 Hot-shots Module for Nest.js Framework
- Host: GitHub
- URL: https://github.com/socketsomeone/nestjs-hot-shots
- Owner: SocketSomeone
- License: mit
- Created: 2021-12-05T12:28:00.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-22T22:58:56.000Z (11 months ago)
- Last Synced: 2024-11-24T20:49:50.146Z (11 months ago)
- Topics: datadog, hot-shots, metrics, nest, nestjs, telegraf, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/nestjs-hot-shots
- Size: 2.69 MB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# NestJS Hot-shots    
Hot-shots Module for Nest.js Framework. A Node.js client for [Etsy](http://etsy.com)'s [StatsD](https://github.com/statsd/statsd) server, Datadog's [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/?tab=hostagent) server, and [InfluxDB's](https://github.com/influxdata/telegraf) Telegraf
StatsD server.
**Features**
- TypeScript types
- Telegraf support
- Events
- Child clients
- TCP/UDS Protocol support
- Raw Stream Protocol support
- Mock mode
- Much more, including many bug fixes
For questions and support please use
the [Issues](https://github.com/SocketSomeone/nestjs-hot-shots/issues/new?assignees=&labels=question&template=question.yml).
## Installation
```bash
$ npm i nestjs-hot-shots hot-shots
$ yarn add nestjs-hot-shots hot-shots
$ pnpm add nestjs-hot-shots hot-shots
```
## Usage
Once the installation process is complete, we can import the `HotShotsModule` into the root `AppModule`:
```typescript
import { Module } from '@nestjs/common'
import { HotShotsModule } from 'nestjs-hot-shots';
@Module({
imports: [
HotShotsModule.forRoot({
port: 8020,
globalTags: { env: process.env.NODE_ENV }
})
]
})
export class AppModule {
}
```
Then inject `StatsD` provider for use `hot-shots`:
```typescript
import { Injectable } from '@nestjs/common';
import { StatsD } from 'hot-shots';
@Injectable()
export class AppMetrics {
public constructor(private readonly metrics: StatsD) {
}
public metricStuff() {
this.metrics.increment('somecounter');
}
}
```
See the [hot-shots](https://www.npmjs.com/package/hot-shots) module for more details.
## Stay in touch
* Author - [Alexey Filippov](https://t.me/socketsomeone)
* Twitter - [@SocketSomeone](https://twitter.com/SocketSomeone)
## License
[MIT](https://github.com/SocketSomeone/nestjs-hot-shots/blob/master/LICENSE) © [Alexey Filippov](https://github.com/SocketSomeone)