Skip to content

Commit

Permalink
Formatting issues (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
chtushar authored Apr 26, 2024
1 parent a5cd8af commit 49e6263
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ process.on('SIGTERM', gracefullyShutdown);
1. [Express](#express)
2. [MySQL](#mysql)
3. [NestJS](#nestjs)
4. [Next.js][#nextjs]
4. [Next.js](#nextjs)

### Express

Expand Down Expand Up @@ -175,9 +175,17 @@ const openapm = new OpenAPM({
}
```

11. `enabled`: (Optional) Defaults to `true`. When set to `false` OpenAPM will be disabled and no metrics will be collected or emitted.

```
const openapm = new OpenAPM({
enabled: process.env.NODE_ENV === 'production'
})
```

## API Reference

1. `instrument`: Used to instrument supported technologies. Refer the [usage][#usage] section.
1. `instrument`: Used to instrument supported technologies. Refer the [usage](#usage) section.

2. `getMetrics`: Returns a Promise of string which contains metrics in Prometheus exposition format. You can use this function to expose a metrics endpoint if `enableMetricsServer` is set to false. For example,

Expand Down

0 comments on commit 49e6263

Please sign in to comment.