////
This file is generated! See scripts/mage/docs_collector.go
////

:modulename: graphite

[[metricbeat-module-graphite]]
== Graphite module

This is the Graphite module.

The default metricset is `server`.


[float]
=== Example configuration

The Graphite module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
metricbeat.modules:
- module: graphite
  metricsets: ["server"]
  enabled: true

  # Host address to listen on. Default localhost.
  #host: localhost

  # Listening port. Default 2003.
  #port: 2003

  # Protocol to listen on. This can be udp or tcp. Default udp.
  #protocol: "udp"

  # Receive buffer size in bytes
  #receive_buffer_size: 1024

  #templates:
  #  - filter: "test.*.bash.*" # This would match metrics like test.localhost.bash.stats
  #    namespace: "test"
  #    template: ".host.shell.metric*" # test.localhost.bash.stats would become metric=stats and tags host=localhost,shell=bash
  #    delimiter: "_"

----

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-graphite-server,server>>

include::graphite/server.asciidoc[]

