-

TCollector

+

TCollector

tcollector is a client-side process that gathers data from local collectors and pushes the data to OpenTSDB. You run it on all your hosts, and it does the work of sending each @@ -138,7 +142,7 @@

TCollector -

Deduplication

+

Deduplication

Typically you want to gather data about everything in your system. This generates a lot of datapoints, the majority of which don’t change very often over time (if ever). However, you want fine-grained @@ -155,7 +159,7 @@

Deduplication -

Collecting lots of metrics with tcollector

+

Collecting lots of metrics with tcollector

Collectors in tcollector can be written in any language. They just need to be executable and output the data to stdout. Tcollector will handle the rest. The collectors are placed in the collectors directory. Tcollector @@ -176,30 +180,42 @@

Collecting lots of metrics with tcollectorlib and etc directory for library and config data used by all collectors.

-
-

Installation of tcollector

-

You need to clone tcollector from GitHub:

-
git clone git://github.com/OpenTSDB/tcollector.git
-
+
+

Runtime Requirements for tcollector

+
+
tcollector requires one of following python versions: 3.7, 3.8, 3.9, 3.10, 3.11.
+
Each non general collector may have additional requirements.
-

and edit ‘tcollector/startstop’ script to set following variable: -TSD_HOST=dns.name.of.tsd

+
+
+

Installation of tcollector

+
    +

  1. Clone or download tcollector archive from GitHub on +https://github.com/OpenTSDB/tcollector .

    2. +

  2. Review collectors in collectors directory and remove ones you do not need so they +do not start needlessly after each tcollector restart.

    3. +

  3. Consider using of shell script tcollector/tcollector to run tcollector if you want +to auto start after OS restart.

    4. +
+
+

Note

To avoid having to run mkmetric for every metric that tcollector tracks you can to start TSD with the --auto-metric flag. This is useful to get started quickly, but it’s not recommended to keep this flag in the long term, to avoid accidental metric creation.

+
-

Collectors bundled with tcollector

+

Collectors bundled with tcollector

The following are the collectors we’ve included as part of the base package, together with all of the metric names they report on and what they mean. If you have any others you’d like to contribute, we’d love to hear about them so we can reference them or include them with your permission in a future release.

-

General collectors

+

General collectors

-

0/dfstat.py

+

0/dfstat.py

These stats are similar to ones provided by /usr/bin/df util.

  • @@ -241,7 +257,7 @@

    0/dfstat.py

-

0/ifstat.py

+

0/ifstat.py

These stats are from /proc/net/dev.

  • @@ -272,7 +288,7 @@

    0/ifstat.pyiface=.

-

0/iostat.py

+

0/iostat.py

Data is from /proc/diskstats.

  • @@ -325,7 +341,7 @@

    0/iostat.pyiostat.disk.* and by-partition data to iostat.part.*.

-

0/netstat.py

+

0/netstat.py

Socket allocation and network statistics.

Metrics from /proc/net/sockstat.

    @@ -437,7 +453,7 @@

    0/netstat.py

-

0/nfsstat.py

+

0/nfsstat.py

These stats are from /proc/net/rpc/nfs.

  • @@ -465,7 +481,7 @@

    0/nfsstat.pyRFC5661.

-

0/procnettcp.py

+

0/procnettcp.py

These stats are all from /proc/net/tcp{,6}. (Note if IPv6 is enabled, some IPv4 connections seem to get put into /proc/net/tcp6). Collector sleeps 60 seconds in between intervals. Due in part to a kernel performance @@ -497,7 +513,7 @@

0/procnettcp.py under 10 values per interval.

-

0/procstats.py

+

0/procstats.py

Miscellaneous stats from /proc.

  • @@ -582,7 +598,7 @@

    0/procstats.py<

-

0/smart-stats.py

+

0/smart-stats.py

Stats from SMART disks.

  • @@ -810,9 +826,9 @@

    0/smart-stats.p

-

Other collectors

+

Other collectors

-

0/couchbase.py

+

0/couchbase.py

Stats from couchbase (document-oriented NoSQL database).

All metrics are tagged with name of related bucket(bucket=). A bucket is a logical grouping of physical resources within a cluster of Couchbase @@ -823,13 +839,13 @@

0/couchbase.py< Cbstats documentation.

-

0/elasticsearch.py

+

0/elasticsearch.py

Stats from Elastic Search (search and analytics engine).

Refer to the following documentation for metrics description: ElasticSearch cluster APIs.

-

0/hadoop_datanode_jmx.py

+

0/hadoop_datanode_jmx.py

Stats from Hadoop (framework for the distributed processing), DataNode stats.

Following metrics are disabled at the collector by default: revision, hdfsUser, hdfsDate, hdfsUrl, date, hdfsRevision, user, hdfsVersion, url, @@ -839,7 +855,7 @@

0/hadoop_datano HBase metrics.

-

0/haproxy.py

+

0/haproxy.py

Stats from Haproxy (TCP/HTTP load balancer).

  • @@ -859,7 +875,7 @@

    0/haproxy.py

-

0/hbase_regionserver_jmx.py

+

0/hbase_regionserver_jmx.py

Stats from Hadoop (framework for the distributed processing), RegionServer stats.

Following metrics are disabled at the collector by default: revision, hdfsUser, @@ -869,13 +885,13 @@

0/hbase_regions HBase metrics.

-

0/mongo.py

+

0/mongo.py

Stats from Mongo (document NoSQL database).

Refer to the following documentation for metrics description: Mongo DB server-status.

-

0/mysql.py

+

0/mysql.py

Stats from MySQL (relational database).

Refer to the following documentation for metrics description: InnoDB Innodb monitors, @@ -885,25 +901,25 @@

0/mysql.pyShow process list.

-

0/postgresql.py

+

0/postgresql.py

Stats from PostgreSQL (relational database).

Refer to the following documentation for metrics description: PostgreSQL monitoring stats.

-

0/redis-stats.py

+

0/redis-stats.py

Stats from Redis (key-value store).

Refer to the following documentation for metrics description: Redis info comands.

-

0/riak.py

+

0/riak.py

Stats from Riak (document NoSQL database).

Refer to the following documentation for metrics description: Riak statistics.

-

0/varnishstat.py

+

0/varnishstat.py

Stats from Varnish (HTTP accelerator).

By default all metrics collected, it can be changed by editing “vstats” array of the collector.

@@ -911,7 +927,7 @@

0/varnishstat.p “varnishstat -l” to have lists the available metrics.

-

0/zookeeper.py

+

0/zookeeper.py

Stats from Zookeeper (centralized service for distributed synchronization).

Refer to the following documentation for metrics description: Zookeeper admin commands.

@@ -945,7 +961,7 @@

Navigation