X-Git-Url: https://git.octo.it/?a=blobdiff_plain;ds=inline;f=README;h=03c821a1a2e0363ea07c62889af8191430eef8c2;hb=319e18c6784eb653990ac277ef45bf482d29fdc5;hp=e8f0ca1e2aefddc8f6f497ec4fc03901cdc39b22;hpb=b4a45047de41551b5b8879eba548dcf2a199fa9b;p=collectd.git
diff --git a/README b/README
index e8f0ca1e..03c821a1 100644
--- a/README
+++ b/README
@@ -96,6 +96,10 @@ Features
DNS traffic: Query types, response codes, opcodes and traffic/octets
transferred.
+ - dpdkstat
+ Collect DPDK interface statistics.
+ See docs/BUILD.dpdkstat.md for detailed build instructions.
+
- drbd
Collect individual drbd resource statistics.
@@ -128,9 +132,6 @@ Features
- gps
Monitor gps related data through gpsd.
- - grpc
- Receive values over the network using the gRPC framework.
-
- hddtemp
Hard disk temperatures using hddtempd.
@@ -164,7 +165,8 @@ Features
- java
Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
- bytecode. See âConfiguring with libjvmâ below.
+ bytecode.
+ See docs/BUILD.java.md for detailed build instructions.
- load
System load average over the last 1, 5 and 15 minutes.
@@ -187,14 +189,14 @@ Features
Queries very detailed usage statistics from wireless LAN adapters and
interfaces that use the Atheros chipset and the MadWifi driver.
- - mbmon
- Motherboard sensors: temperature, fan speed and voltage information,
- using mbmon(1).
-
- md
Linux software-RAID device information (number of active, failed, spare
and missing disks).
+ - mbmon
+ Motherboard sensors: temperature, fan speed and voltage information,
+ using mbmon(1).
+
- memcachec
Query and parse data from a memcache daemon (memcached).
@@ -214,9 +216,6 @@ Features
Reads values from Modbus/TCP enabled devices. Supports reading values
from multiple "slaves" so gateway devices can be used.
- - mqtt
- Publishes and subscribes to MQTT topics.
-
- multimeter
Information provided by serial multimeters, such as the `Metex
M-4650CR'.
@@ -395,7 +394,7 @@ Features
CPU, memory, disk and network I/O statistics from virtual machines.
- vmem
- Virtual memory statistics, e. g. the number of page-ins/-outs or the
+ Virtual memory statistics, e.g. the number of page-ins/-outs or the
number of pagefaults.
- vserver
@@ -433,10 +432,16 @@ Features
diskspace but is extremely portable and can be analysed with almost
every program that can analyse anything. Even Microsoft's Excel..
+ - grpc
+ Send and receive values over the network using the gRPC framework.
+
- lua
It's possible to implement write plugins in Lua using the Lua
plugin. See collectd-lua(5) for details.
+ - mqtt
+ Publishes and subscribes to MQTT topics.
+
- network
Send the data to a remote host to save the data somehow. This is useful
for large setups where the data should be saved by a dedicated machine.
@@ -656,12 +661,22 @@ Prerequisites
* Usual suspects: C compiler, linker, preprocessor, make, ...
+ collectd makes use of some common C99 features, e.g. compound literals and
+ mixed declarations, and therefore requires a C99 compatible compiler.
+
+ On Debian and Ubuntu, the "build-essential" package should pull in
+ everything that's necessary.
+
* A POSIX-threads (pthread) implementation.
Since gathering some statistics is slow (network connections, slow devices,
etc) collectd is parallelized. The POSIX threads interface is being
used and should be found in various implementations for hopefully all
platforms.
+ * When building from the Git repository, flex (tokenizer) and bison (parser
+ generator) are required. Release tarballs include the generated files â you
+ don't need these packages in that case.
+
* aerotools-ng (optional)
Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
is used by the `aerotools-ng' toolkit, is not compiled as a shared object
@@ -736,8 +751,8 @@ Prerequisites
* libjvm (optional)
Library that encapsulates the `Java Virtual Machine' (JVM). This library is
- used by the `java' plugin to execute Java bytecode. See âConfiguring with
- libjvmâ below.
+ used by the `java' plugin to execute Java bytecode.
+ See docs/BUILD.java.md for detailed build instructions.
(and others)
* libldap (optional)
@@ -931,44 +946,6 @@ Configuring / Compiling / Installing
prefixed to all installation directories. This might be useful when creating
packages for collectd.
-Configuring with libjvm
------------------------
-
- To determine the location of the required files of a Java installation is not
- an easy task, because the locations vary with your kernel (Linux, SunOS, â¦)
- and with your architecture (x86, SPARC, â¦) and there is no âjava-configâ
- script we could use. Configuration of the JVM library is therefore a bit
- tricky.
-
- The easiest way to use the `--with-java=$JAVA_HOME' option, where
- `$JAVA_HOME' is usually something like:
- /usr/lib/jvm/java-1.5.0-sun-1.5.0.14
-
- The configure script will then use find(1) to look for the following files:
-
- - jni.h
- - jni_md.h
- - libjvm.so
-
- If found, appropriate CPP-flags and LD-flags are set and the following
- library checks succeed.
-
- If this doesn't work for you, you have the possibility to specify CPP-flags,
- C-flags, LD-flags and LIBS for the âJavaâ plugin by hand, using the
- following environment variables:
-
- - JAVA_CPPFLAGS
- - JAVA_CFLAGS
- - JAVA_LDFLAGS
- - JAVA_LIBS
-
- For example (shortened for demonstration purposes):
-
- ./configure JAVA_CPPFLAGS="-I$JAVA_HOME/include -I$JAVA_HOME/include/linux"
-
- Adding "-ljvm" to JAVA_LIBS is done automatically, you don't have to
- do that.
-
Generating the configure script
-------------------------------
@@ -987,6 +964,7 @@ To generate the `configure` script, you'll need the following dependencies:
The `build.sh' script takes no arguments.
+
Crosscompiling
--------------
@@ -1021,8 +999,12 @@ Crosscompiling
Contact
-------
- For questions, bug reports, development information and basically all other
- concerns please send an email to collectd's mailing list at
+ Please use GitHub to report bugs and submit pull requests:
+ .
+ See CONTRIBUTING.md for details.
+
+ For questions, development information and basically all other concerns please
+ send an email to collectd's mailing list at
.
For live discussion and more personal contact visit us in IRC, we're in
@@ -1036,5 +1018,3 @@ Author
Sebastian tokkee Harl ,
and many contributors (see `AUTHORS').
- Please use GitHub reporting bugs and submitting pull requests.
- See CONTRIBUTING.md for details.