Skip to content

Update Portworx Integration: metric names and readme#2974

Open
KritikaG05 wants to merge 6 commits into
DataDog:masterfrom
KritikaG05:master
Open

Update Portworx Integration: metric names and readme#2974
KritikaG05 wants to merge 6 commits into
DataDog:masterfrom
KritikaG05:master

Conversation

@KritikaG05
Copy link
Copy Markdown

What does this PR do?

This PR updates the Portworx integration README and metrics to align with the latest Portworx documentation and current integration behavior.
The changes primarily include documentation updates and metadata adjustments, with no functional code changes.

Motivation

What inspired you to submit this pull request?
The existing README and metric metadata were slightly outdated compared to the latest Portworx documentation.
This update ensures users have accurate information about available metrics and configuration, improving clarity and reducing confusion when using the Portworx integration.

Review checklist

  • [ x] PR has a meaningful title or PR has the no-changelog label attached
  • Feature or bugfix has tests
  • [ x] Git history is clean
  • If PR impacts documentation, docs team has been notified or an issue has been opened on the documentation repo
  • If this PR includes a log pipeline, please add a description describing the remappers and processors.

Additional Notes

Anything else we should know when reviewing?
This PR only updates documentation and metadata. No changes to functionality, integration behavior, or metric collection logic are included.

@KritikaG05 KritikaG05 requested a review from a team as a code owner April 22, 2026 10:45
@KritikaG05 KritikaG05 marked this pull request as draft April 22, 2026 11:26
@KritikaG05 KritikaG05 force-pushed the master branch 2 times, most recently from 6dbbaa0 to 607cbfa Compare May 5, 2026 06:07
@KritikaG05 KritikaG05 marked this pull request as ready for review May 5, 2026 08:32
@KritikaG05 KritikaG05 changed the title Portworx Integration: metric names and readme update Update Portworx Integration: metric names and readme May 5, 2026
@KritikaG05
Copy link
Copy Markdown
Author

Hi @steveny91 @rtrieu
Can you pls guide me on the right reviewer for this change? I am unable to tag the docs team directly.

I need to update the portworx contact person email and info as well in the code maintainers.

@rtrieu
Copy link
Copy Markdown
Contributor

rtrieu commented May 5, 2026

Hi @KritikaG05, we have an on-call person who should be handling or triaging this PR today.

@domalessi domalessi self-assigned this May 5, 2026
Copy link
Copy Markdown
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! The new Kubernetes-based setup flow is clearer than the old host-based instructions. A few structural items to address before merging:

Missing required sections:

  • Service Checks subsection under Data Collected is missing. The manifest references a service_checks.json asset, so the README should either list the service checks or state "The Portworx integration does not include any service checks."
  • Support section is missing. manifest.json references README.md#Support, but no ## Support heading exists. For integrations-extras, this section should direct users to your support team (Pure Storage / Portworx).

Step numbering structure is confusing:

  • Steps 1, 2.1, 2.2 sit under ### Installation, but Step 2.3 jumps over to ### Configuration. Then Step 3 follows under Configuration. Either keep all numbered steps under one heading, or restart numbering when crossing the Installation/Configuration boundary.
  • The #### Step N - Title heading style with hyphen separator is atypical. Consider dropping the "Step N -" prefix and using descriptive sentence-case headings (e.g., #### Create the Datadog credentials Secret).

metadata.csv regressions:

  • Many new metrics with byte/second values are missing unit_name (e.g., px_backup_stats_backup_size, px_backup_stats_backup_duration_seconds, px_device_delete_discard_bytes_total, px_pool_stats_provisioned_bytes, px_volume_usage_bytes, etc.). Please populate unit_name (and per_unit_name where applicable) for all metrics whose descriptions mention bytes, seconds, or other units.
  • The previous metric set had short_name populated for every metric, but every new metric leaves short_name empty. This is a regression — short_name is used in the Datadog UI. Please populate it.

Pre-existing nits in nearby unchanged lines (optional, since you're already touching the Overview):

  • L7: "your Portworx Cluster" — "Cluster" should be lowercase.
  • L8: missing Oxford comma — "disk usage, latency, and throughput".

Comment thread portworx/README.md Outdated
Comment thread portworx/README.md Outdated
Comment thread portworx/README.md Outdated
Comment thread portworx/README.md Outdated
Comment thread portworx/README.md Outdated
Comment thread portworx/README.md Outdated
Comment thread portworx/README.md Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
portworx.px_device_delete_operations_inprogress,gauge,,,,Current operations in progress,0,portworx,,
portworx.px_device_delete_operations_queued,gauge,,,,Current operations queued,0,portworx,,
portworx.px_disk_stats_used_bytes,gauge,,byte,,Total storage in bytes for this disk,0,portworx,,
portworx.px_disk_stats_interval_seconds,gauge,,second,,interval_seconds,0,portworx,,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description is just the metric name repeated, which isn't useful to users. Replace with a real description.

Suggested change
portworx.px_disk_stats_interval_seconds,gauge,,second,,interval_seconds,0,portworx,,
portworx.px_disk_stats_interval_seconds,gauge,,second,,Length of the disk stats sampling interval in seconds,0,portworx,,

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is in accordance to our official docs https://docs.portworx.com/portworx-enterprise/reference/metrics. Have updated it a bit though

Comment thread portworx/metadata.csv Outdated
@KritikaG05
Copy link
Copy Markdown
Author

KritikaG05 commented May 12, 2026

Hi @domalessi
Thanks for the quick review.
Have resolved the comments, requesting a re-review.

Copy link
Copy Markdown
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! A few more minor things. Comments/suggestions in line. Tag me and/or re-request review when ready for a final look.

Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/README.md Outdated
Comment thread portworx/README.md
Run the following command to confirm the Agent is scraping Portworx metrics:

```shell
kubectl exec <datadog-agent-pod> -n <datadog-namespace> -- agent status
Copy link
Copy Markdown
Contributor

@domalessi domalessi May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Kubernetes namespace is referenced inconsistently across this section: literal datadog-ns on lines 24 and 148, but <datadog-namespace> placeholder here and on lines 192 and 196. Pick one convention (either treat the namespace as a placeholder everywhere, or use a literal example (and explain it once)) and stick with it.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @domalessi
I believe this is consistent already.
Line no: 156, 191,195 use the placeholder.
Line no. 24 is a complete yaml example - with the explanation on Line no 33, to replace the namespace name as deemed fit.

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
@KritikaG05 KritikaG05 requested a review from domalessi May 14, 2026 11:05
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Comment thread portworx/metadata.csv Outdated
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes, @KritikaG05 ! Approved from an editorial perspective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants