Skip to content

Add installation how-to #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ nginx-statsd

An nginx module for sending statistics to statsd.

# Installation

Configure your nginx/openresty from source with:

`./configure --add-module=/path/to/nginx-statsd-source`

..compile it with `make` and install with `make install`.

# Usage

This is how to use the nginx-statsd module:

http {
Expand All @@ -11,7 +21,7 @@ This is how to use the nginx-statsd module:
statsd_server your.statsd.server.com;

# Randomly sample 10% of requests so that you do not overwhelm your statsd server.
# Defaults to sending all statsd (100%).
# Defaults to sending all statsd (100%).
statsd_sample_rate 10; # 10% of requests


Expand Down