README.md

PHP OpenTSDB HTTP API Client

Introduction

This package allows you to send (push) metrics (data points) to the OpenTSDB database from the PHP application using an HTTP API.

• OpenTSDB HTTP API

This package does not cover Telnet API, and that's why:

• Telnet API use cases: quick tests, debugging, or simple commands in a development environment.
• HTTP API use cases: production applications, complex data queries, integrations with other systems, and secure communications.

OpenTSDB HTTP API supported by:

• VictoriaMetrics (because of limited functionality only sendDataPointList method is supported)

What is OpenTSDB

OpenTSDB is a distributed, scalable Time Series Database (TSDB) written on top of HBase. OpenTSDB was written to address a common need: store, index and serve metrics collected from computer systems (network gear, operating systems, applications) at a large scale, and make this data easily accessible and graphable.

OpenTSDB provides an HTTP based application programming interface to enable integration with external systems. Almost all OpenTSDB features are accessible via the API such as querying time-series data, managing metadata and storing data points.

Usage

$dataPointList[] = new \Cog\OpenTsdbClient\DataPoint(
    metric: 'temperature',
    timestamp: time(),
    value: -38.04,
    tags: ['place' => 'south_pole'],
);
$dataPointList[] = new \Cog\OpenTsdbClient\DataPoint(
    metric: 'temperature',
    timestamp: time(),
    value: -2.12,
    tags: ['place' => 'north_pole'],
);

$openTsdbClient = new \Cog\OpenTsdbClient\OpenTsdbClient(
    httpClient: \Http\Adapter\Guzzle7\Client::createWithConfig(
        [
            'timeout' => 4,
            'connect_timeout' => 2,
            'http_errors' => false,
        ],
    ),
    baseUri: 'http://opentsdb:4242',
);

$openTsdbClient->sendDataPointList($dataPointList);

Alternatives

• Java: sps/metrics-opentsdb
• Go: bluebreezecf/opentsdb-goclient
• .net: dejanfajfar/openTSDB.net

License

• PHP OpenTSDB HTTP API Client package is open-sourced software licensed under the MIT license by Anton Komarev.

🌟 Stargazers over time

About CyberCog

CyberCog is a Social Unity of enthusiasts. Research the best solutions in product & software development is our passion.

• Follow us on Twitter