aboutsummaryrefslogtreecommitdiff
path: root/network/graphite-carbon/man1
diff options
context:
space:
mode:
authorMario Preksavec <mario at slackware dot hr>2015-02-06 20:32:58 +0700
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2015-02-06 20:32:58 +0700
commit8e345cefbe19d133e041bd99e469ce3d044ea7dc (patch)
treefeed123081bd13abb57d1382854a911c054dc890 /network/graphite-carbon/man1
parent171e85069717f372bfd9ba8ad6215f31bcc19bf2 (diff)
network/graphite-carbon: Added (Backend data caching).
Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
Diffstat (limited to 'network/graphite-carbon/man1')
-rw-r--r--network/graphite-carbon/man1/carbon-aggregator.156
-rw-r--r--network/graphite-carbon/man1/carbon-cache.150
-rw-r--r--network/graphite-carbon/man1/carbon-client.143
-rw-r--r--network/graphite-carbon/man1/carbon-relay.151
-rw-r--r--network/graphite-carbon/man1/validate-storage-schemas.117
5 files changed, 217 insertions, 0 deletions
diff --git a/network/graphite-carbon/man1/carbon-aggregator.1 b/network/graphite-carbon/man1/carbon-aggregator.1
new file mode 100644
index 0000000000000..a8ab95294d27e
--- /dev/null
+++ b/network/graphite-carbon/man1/carbon-aggregator.1
@@ -0,0 +1,56 @@
+.TH CARBON-AGGREGATOR 1
+.SH NAME
+carbon-aggregator \- buffer metrics over time before reporting to carbon-cache
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-aggregator\fP [options] start
+.fam T
+.fi
+.SH DESCRIPTION
+carbon-aggregator can be run in front of carbon-cache to buffer metrics over
+time before reporting them into whisper.
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Run in the foreground, log to stdout
+.TP
+.B
+\-\-profile=PROFILE
+Record performance profile data to the given file
+.TP
+.B
+\-\-pidfile=PIDFILE
+Write pid to the given file
+.TP
+.B
+\-\-config=CONFIG
+Use the given config file
+.TP
+.B
+\-\-logdir=LOGDIR
+Write logs in the given directory
+.TP
+.B
+\-\-instance=INSTANCE
+Manage a specific carbon instance
+.TP
+.B
+\-\-rules=RULES
+Use the given aggregation rules file.
+.TP
+.B
+\-\-rewrite-rules=REWRITE_RULES
+Use the given rewrite rules file.
+.SH AUTHOR
+\fBcarbon-aggregator\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt@capi2name.de, for
+the Debian project (but may be used by others).
diff --git a/network/graphite-carbon/man1/carbon-cache.1 b/network/graphite-carbon/man1/carbon-cache.1
new file mode 100644
index 0000000000000..39174d7449578
--- /dev/null
+++ b/network/graphite-carbon/man1/carbon-cache.1
@@ -0,0 +1,50 @@
+.TH CARBON-CACHE 1
+.SH NAME
+carbon-cache \- accepts metrics over various protocols and writes them to disk
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-cache\fP [options] start
+.fam T
+.fi
+.SH DESCRIPTION
+carbon-cache accepts metrics over various protocols and writes them to disk as
+efficiently as possible. This requires caching metric values in RAM as they are
+received, and flushing them to disk on an interval using the underlying
+whisper library.
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Run in the foreground, log to stdout
+.TP
+.B
+\-\-profile=PROFILE
+Record performance profile data to the given file
+.TP
+.B
+\-\-pidfile=PIDFILE
+Write pid to the given file
+.TP
+.B
+\-\-config=CONFIG
+Use the given config file
+.TP
+.B
+\-\-logdir=LOGDIR
+Write logs in the given directory
+.TP
+.B
+\-\-instance=INSTANCE
+Manage a specific carbon instance
+.SH AUTHOR
+\fBcarbon-cache\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt@capi2name.de, for
+the Debian project (but may be used by others).
diff --git a/network/graphite-carbon/man1/carbon-client.1 b/network/graphite-carbon/man1/carbon-client.1
new file mode 100644
index 0000000000000..d954d4158fd8a
--- /dev/null
+++ b/network/graphite-carbon/man1/carbon-client.1
@@ -0,0 +1,43 @@
+.TH CARBON-CLIENT 1
+.SH NAME
+carbon-client \- Graphite client to reroute carbon data
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-client\fP [options]
+.fam T
+.fi
+.SH DESCRIPTION
+Graphite client to reroute carbon data
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Log debug info to stdout
+.TP
+.B
+\-\-keyfunc=KEYFUNC
+Use a custom key function (path/to/module.py:myFunc)
+.TP
+.B
+\-\-replication=REPLICATION
+Replication factor
+.TP
+.B
+\-\-routing=ROUTING
+Routing method: "consistent-hashing" (default) or "relay"
+.TP
+.B
+\-\-relayrules=RELAYRULES
+relay-rules.conf file to use for relay routing
+.SH AUTHOR
+\fBcarbon-client\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt@capi2name.de, for
+the Debian project (but may be used by others).
diff --git a/network/graphite-carbon/man1/carbon-relay.1 b/network/graphite-carbon/man1/carbon-relay.1
new file mode 100644
index 0000000000000..0ee27548b39a7
--- /dev/null
+++ b/network/graphite-carbon/man1/carbon-relay.1
@@ -0,0 +1,51 @@
+.TH CARBON-RELAY 1
+.SH NAME
+carbon-relay \- replication and sharding data
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-relay\fP [options] start
+.fam T
+.fi
+.SH DESCRIPTION
+carbon-relay serves two distinct purposes: replication and sharding.
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Run in the foreground, log to stdout
+.TP
+.B
+\-\-profile=PROFILE
+Record performance profile data to the given file
+.TP
+.B
+\-\-pidfile=PIDFILE
+Write pid to the given file
+.TP
+.B
+\-\-config=CONFIG
+Use the given config file
+.TP
+.B
+\-\-logdir=LOGDIR
+Write logs in the given directory
+.TP
+.B
+\-\-instance=INSTANCE
+Manage a specific carbon instance
+.TP
+.B
+\-\-rules=RULES
+se the given relay rules file.
+.SH AUTHOR
+\fBcarbon-relay\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt@capi2name.de, for
+the Debian project (but may be used by others).
diff --git a/network/graphite-carbon/man1/validate-storage-schemas.1 b/network/graphite-carbon/man1/validate-storage-schemas.1
new file mode 100644
index 0000000000000..07eadb3358027
--- /dev/null
+++ b/network/graphite-carbon/man1/validate-storage-schemas.1
@@ -0,0 +1,17 @@
+.TH VALIDATE-STORAGE-SCHEMAS 1
+.SH NAME
+validate-storage-schemas \- validates the storage schemas
+.SH SYNOPSYS
+.nf
+.fam C
+\fbvalidate-storage-schemas\fP
+.fam T
+.fi
+.SH DESCRIPTION
+validates the storage schemas from the configuration
+file /etc/carbon/storage-schemas.conf.
+.SH AUTHOR
+\fBvalidate-storage-schemas\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt@capi2name.de, for
+the Debian project (but may be used by others).