Skip to content
This repository was archived by the owner on Oct 21, 2024. It is now read-only.

Commit 0479655

Browse files
update readme with usage example and options
1 parent 9390c99 commit 0479655

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
Datadog middleware for Connect JS / Express
44

5+
6+
## Usage
7+
8+
Add middleware immediately before your router.
9+
10+
app.use(require("connect-datadog")({}));
11+
app.use(app.router);
12+
13+
## Options
14+
15+
All options are optional.
16+
17+
* `dogstatsd` node-dogstatsd client. `default = new require("node-dogstatsd").StatsD()`
18+
* `stat` *string* name for the stat. `default = "node.express.router"`
19+
* `tags` *array* of tags to be added to the histogram. `default = []`
20+
21+
522
## License
623

724
View the [LICENSE](https://github.com/AppPress/node-connect-datadog/blob/master/LICENSE) file.
25+

0 commit comments

Comments
 (0)