https://github.com/collectd/go-collectd

Utilities for using collectd together with Golang.
https://github.com/collectd/go-collectd

Last synced: 3 months ago
JSON representation

Utilities for using collectd together with Golang.

• Host: GitHub
• URL: https://github.com/collectd/go-collectd
• Owner: collectd
• License: isc
• Created: 2015-03-05T21:59:39.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-04T16:33:24.000Z (10 months ago)
• Last Synced: 2024-07-16T13:08:57.824Z (4 months ago)
• Language: Go
• Size: 328 KB
• Stars: 121
• Watchers: 23
• Forks: 32
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# go-collectd

Utilities for using [collectd](https://collectd.org/) together with [Go](http://golang.org/).

# Synopsis

    package main

    

    import (

        "context"

        "time"

        

        "collectd.org/api"

        "collectd.org/exec"

    )

    

    func main() {

        vl := api.ValueList{

            Identifier: api.Identifier{

                Host:   exec.Hostname(),

                Plugin: "golang",

                Type:   "gauge",

            },

            Time:     time.Now(),

            Interval: exec.Interval(),

            Values:   []api.Value{api.Gauge(42)},

        }

        exec.Putval.Write(context.Background(), &vl)

    }

# Description

This is a very simple package and very much a *Work in Progress*, so expect

things to move around and be renamed a lot.

The repository is organized as follows:

* Package `collectd.org/api` declares data structures you may already know from

  the *collectd* source code itself, such as `ValueList`.

* Package `collectd.org/exec` declares some utilities for writing binaries to

  be executed with the *exec plugin*. It provides some utilities (getting the

  hostname, e.g.) and an executor which you may use to easily schedule function

  calls.

* Package `collectd.org/format` declares functions for formatting *ValueLists*

  in other format. Right now, only `PUTVAL` is implemented. Eventually I plan

  to add parsers for some formats, such as the JSON export.

* Package `collectd.org/network` implements collectd's

  [binary network protocol](https://collectd.org/wiki/index.php/Binary_protocol).

  It offers client and server implementations, see `network.Client` and

  `network.ListenAndWrite()` for more details.

# Install

To use this package in your own programs, simply use `go get` to fetch the

packages you need, for example:

    go get collectd.org/api

# Author

Florian "octo" Forster <ff at octo.it>