Last updated 3rd June 2021
Objective
InfluxDB is a time series database optimized for high-write-volume use cases such as logs, sensor data, and real-time analytics.
It exposes an HTTP API for client interaction. See the InfluxDB documentation for more information.
Supported versions
Grid |
---|
1.2 |
1.3 |
1.7 |
1.8 |
Relationship
The format exposed in the $PLATFORM_RELATIONSHIPS
environment variable:
{
"service": "influxdb18",
"ip": "169.254.234.110",
"hostname": "duqbjfn7t4dwr2fi2o7bsvqafy.influxdb18.service._.eu-3.platformsh.site",
"cluster": "rjify4yjcwxaa-master-7rqtwti",
"host": "influxdb.internal",
"rel": "influxdb",
"scheme": "http",
"type": "influxdb:1.8",
"port": 8086
}
Usage example
In your .platform/services.yaml
:
timedb:
type: influxdb:1.8
disk: 256
In your .platform.app.yaml
:
relationships:
influxtimedb: "timedb:influxdb"
You will need to use
influxdb
type when defining the service```yaml
.platform/services.yaml
service_name: type: influxdb:version disk:256 ```
and the endpoint
influxdb
when defining the relationship```yaml
.platform.app.yaml
relationships: relationship_name: “service_name:influxdb” ```
Your
service_name
andrelationship_name
are defined by you, but we recommend making them distinct from each other.
You can then use the service in a configuration file of your application with something like:
<?php
// This assumes a fictional application with an array named $settings.
if (getenv('PLATFORM_RELATIONSHIPS')) {
$relationships = json_decode(base64_decode($relationships), TRUE);
// For a relationship named 'influxtimedb' referring to one endpoint.
if (!empty($relationships['influxtimedb'])) {
foreach ($relationships['influxtimedb'] as $endpoint) {
$settings['influxdb_host'] = $endpoint['host'];
$settings['influxdb_port'] = $endpoint['port'];
break;
}
}
}
Exporting data
InfluxDB includes its own export mechanism. To gain access to the server from your local machine open an SSH tunnel with the Web PaaS CLI:
webpaas tunnel:open
That will open an SSH tunnel to all services on your current environment, and produce output something like the following:
SSH tunnel opened on port 30000 to relationship: influxtimedb
The port may vary in your case. Then, simply run InfluxDB's export commands as desired.
influx_inspect export -compress
Did you find this guide useful?
Please feel free to give any suggestions in order to improve this documentation.
Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.
Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.
Thank you. Your feedback has been received.