PHP download

Download the PHP package oxil/php-travis-influxdb without Composer

On this page you can find all versions of the php package oxil/php-travis-influxdb. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download oxil/php-travis-influxdb
More information about oxil/php-travis-influxdb
Files in oxil/php-travis-influxdb

Vendor oxil
Package php-travis-influxdb
Short Description Read from Travis CI and write build status and metrics into an influxDB database for e.g. use in Grafana
License

Keywords php travis ci Influx DB

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Informations about the package php-travis-influxdb

php-travis-influxdb

PHP library which reads build data from Travis CI and writes it into an influxdb time series database for e.g. use in Grafana

Overview

A simple PHP library / CLI application designed to read latest build status information from multiple Travis CI repos and insert the results into an Influx DB timeseries database ready for use in monitoring applications etc e.g. Grafana.

Installation

Installation can be done via composer either as a library

composer require oxil/php-travis-influxdb

or as a ready to go CLI application

composer create-project oxil/php-travis-influxdb

Getting started

The entry point is via the Processor class which is instantiated as follows:

$processor = new Oxil\PHPTravisInflux\Processor(CONFIG_PATH);

Where CONFIG_PATH is an absolute path to a configuration file which is in JSON format as follows:

The configuration options are as follows:

useBuildTimestamps - if set to true, only new builds will be added to the influx database. If set to false an entry will be written for each repository on each run.
influxdb - this subset of properties configures the connection to influxdb. host, port and database are required with authentication parameters supplied only if your influxdb instance requires them.
NB: If the database does not exist it will be created automatically on the first run.
travis - this contains the sets of repositories in travis to read the build stati from.
Entries within the travis top level are indexed by an identifier of your choice and typically relate to different endpoints (e.g. when using travis-ci.org and travis-ci.com). The identifier chosen will be used as the measurement name in influxdb for all entries inserted for each repo. Within each entry, the travis ci api endpoint is supplied using the endpoint member and an array of repository names to read build statuses from is supplied using the repositories member.

To trigger a run you can simply call the process method on the processor instantiated above.

$processor->process();

Reading data back from InfluxDB

Data read from Travis CI will be inserted into a measurement within the configured database (see above) as identified by the identifier specified within the travis element of the configuration file.

Each measurement entry will be written with a value of 0 or 1 according to whether the build failed or succeeded respectively. The following tags will also be added to the entry for informational purposes for reporting.

repo - the full string of the repository e.g. OxfordInfoLabs/kinikit-core
short_name - the short name of the repository (last bit after slashes) e.g. kinikit-core
status - either Succeeded or Failed according to the status of the Travis build.
last_run - the last run time for the build as obtained from Travis.

Ready to go CLI Application

There is a ready to go working example CLI script contained in the example directory.

To install this, please use this form of composer installation:

composer create-project oxil/php-travis-influxdb

And then tweak the example/config.json to your needs. You can then run the app by calling

php example/travis_influx.php

All versions of php-travis-influxdb with dependencies

PHP Build Version

Package Version

Version 0.7 Release 22. Oct 2019
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of php-travis-influxdb from vendor oxil

Requires influxdb/influxdb-php Version ^1.15

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package oxil/php-travis-influxdb contains the following files

Loading the files please wait ....