Supported OS:
Get metrics from Portworx service in real time to:
If you are using Agent v6.8+ follow the instructions below to install the Portworx check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior to version 6.8 or the Docker Agent:
Clone the integrations-extras repository:
git clone https://github.com/DataDog/integrations-extras.git.
Update your ddev config with the integrations-extras/ path:
ddev config set extras ./integrations-extras
To build the portworx package, run:
ddev -e release build portworx
Run the following command to install the integrations wheel with the Agent:
datadog-agent integration install -w <PATH_OF_PORTWORX_ARTIFACT_>/<PORTWORX_ARTIFACT_NAME>.whl
Configure your integration like any other packaged integration.
Edit the portworx.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Portworx metrics.
See the sample portworx.d/conf.yaml for all available configuration options.
Add this configuration setup to your portworx.yaml file to start gathering your portworx metrics:
init_config:
instances:
# url of the metrics endpoint of prometheus
- prometheus_endpoint: http://localhost:9001/metrics
Configure it to point to your server and port.
See the sample portworx.yaml for all available configuration options.
Run the Agent’s info subcommand, you should see something like the following:
The Portworx check is compatible with Portworx 1.4.0 and possible earlier versions.
| portworx.cluster.cpu_percent (gauge) | Node CPU Percentage Shown as percent |
| portworx.cluster.disk_available_bytes (gauge) | Node Available disk space Shown as byte |
| portworx.cluster.disk_total_bytes (gauge) | Node total bytes Shown as byte |
| portworx.cluster.disk_utilized_bytes (gauge) | Node Utilized bytes Shown as byte |
| portworx.cluster.memory_utilized_percent (gauge) | Node Memory Utilization Percentage Shown as percent |
| portworx.cluster.pendingio (gauge) | Node Pendiong IO's |
| portworx.cluster.status_cluster.quorum (gauge) | Cluster Quorum |
| portworx.cluster.status_cluster.size (gauge) | Cluster Size |
| portworx.cluster.status_nodes_offline (gauge) | Cluster Number of Offline nodes |
| portworx.cluster.status_nodes_online (gauge) | Cluster Number of Online nodes |
| portworx.cluster.status_nodes_storage_down (gauge) | Cluster Number of nodes with storage down |
| portworx.cluster.status_storage_nodes_offline (gauge) | Cluster Number of nodes with storage offline |
| portworx.cluster.status_storage_nodes_online (gauge) | Cluster Number of nodes with storage online |
| portworx.disk_stats.interval_seconds (gauge) | Disk stats for interval seconds Shown as second |
| portworx.disk_stats.io_seconds (gauge) | Disk stats for io's per seconds Shown as second |
| portworx.disk_stats.progress_io (gauge) | Disk stats for io's in progress Shown as second |
| portworx.disk_stats.read_bytes (gauge) | Disk stats for number of read bytes Shown as byte |
| portworx.disk_stats.read_latency_seconds (gauge) | Disk stats for read latency in seconds Shown as second |
| portworx.disk_stats.read_seconds (gauge) | Disk stats for of reads per seconds Shown as second |
| portworx.disk_stats.reads (gauge) | Disk stats for number of reads |
| portworx.disk_stats.used_bytes (gauge) | Disk stats for used bytes Shown as byte |
| portworx.disk_stats.write_bytes (gauge) | Disk stats for of written bytes Shown as byte |
| portworx.disk_stats.write_latency_seconds (gauge) | Disk stats for write latency in seconds Shown as second |
| portworx.disk_stats.write_seconds (gauge) | Disk stats for writes per seconds Shown as second |
| portworx.disk_stats.writes (gauge) | Disk stats for number of writes |
| portworx.network_io.bytessent (gauge) | Network stats for bytes sent Shown as byte |
| portworx.network_io.received_bytes (gauge) | Network stats for bytes received Shown as byte |
| portworx.pool_stats.pool_flushed_bytes (gauge) | Pool stats for flushed bytes Shown as byte |
| portworx.pool_stats.pool_flushms (gauge) | Pool stats for flush latency Shown as millisecond |
| portworx.pool_stats.pool_num_flushes (gauge) | Pool stats for number of flushes |
| portworx.pool_stats.pool_write_latency_seconds (gauge) | Pool stats for write latency Shown as second |
| portworx.pool_stats.pool_writethroughput (gauge) | Pool stats for write throughput Shown as byte |
| portworx.pool_stats.pool_written_bytes (gauge) | Pool stats for written bytes Shown as byte |
| portworx.proc_stats.cpu_percenttime (gauge) | Proc stats for CPU percent time |
| portworx.proc_stats.res (gauge) | Proc stats for resident memory size |
| portworx.proc_stats.virt (gauge) | Proc stats for virtual memory size |
| portworx.volume.capacity_bytes (gauge) | Volume stats for capacity bytes Shown as byte |
| portworx.volume.currhalevel (gauge) | Volume stats for the current HA level |
| portworx.volume.depth_io (gauge) | Volume stats for io depth |
| portworx.volume.dev_depth_io (gauge) | Volume Device stats for io depth |
| portworx.volume.dev_read_latency_seconds (gauge) | Volume Device stats for read latency Shown as second |
| portworx.volume.dev_readthroughput (gauge) | Volume Device stats for read throughput Shown as byte |
| portworx.volume.dev_write_latency_seconds (gauge) | Volume Device stats for write latency Shown as second |
| portworx.volume.dev_writethroughput (gauge) | Volume Device stats for write throughput Shown as byte |
| portworx.volume.halevel (gauge) | Volume stats for HA Level |
| portworx.volume.iopriority (gauge) | Volume stats for IO Priority |
| portworx.volume.iops (gauge) | Volume stats for IOPS |
| portworx.volume.num_long_flushes (gauge) | Volume stats for number of flushes |
| portworx.volume.num_long_reads (gauge) | Volume stats for number of long reads |
| portworx.volume.num_long_writes (gauge) | Volume stats for number of long writes |
| portworx.volume.readthroughput (gauge) | Volume stats for read throughput Shown as byte |
| portworx.volume.usage_bytes (gauge) | Volume stats for used bytes Shown as byte |
| portworx.volume.vol_read_latency_seconds (gauge) | Volume stats for read latency Shown as second |
| portworx.volume.vol_write_latency_seconds (gauge) | Volume stats for write latency Shown as second |
| portworx.volume.writethroughput (gauge) | Volume stats for write throughput Shown as byte |
| portworx.volume.written_bytes (gauge) | Volume stats for written bytes Shown as byte |
| portworx.fs.usage_bytes (gauge) | Filesystem stats for used bytes Shown as byte |
| portworx.fs.capacity_bytes (gauge) | Filesystem stats for total bytes Shown as byte |
The Portworx check does not include any events.
portworx
-------
- instance #0 [ERROR]: "('Connection aborted.', error(111, 'Connection refused'))"
- Collected 0 metrics, 0 events & 0 service check
Check that the url in portworx.yaml is correct.
Learn more about infrastructure monitoring and all our integrations on our blog.
Mistake in the docs? Feel free to contribute!