Add Proxmox integration (ECOINT-50) #2555

aureleoules · 2024-12-06T09:18:07Z

What does this PR do?

This pull is an hackathon project.
It adds an agent integration for Proxmox with an integration test and a dashboard.

Review checklist

PR has a meaningful title or PR has the no-changelog label attached
Feature or bugfix has tests
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?

eho1307

Hey @aureleoules helping push this along since there are customer requests for it. Thanks for building an integration during the hackathon! I've added comments to ensure it passes all our internal requirements. Let me know if you have any questions or concerns.

proxmox/CHANGELOG.md

proxmox/README.md

proxmox/manifest.json

eho1307 · 2024-12-12T19:17:40Z

proxmox/manifest.json

+    "changelog": "CHANGELOG.md",
+    "description": "Monitor Proxmox with Datadog",
+    "title": "Proxmox",
+    "media": [],


You can reference the image of the dashboard you end up uploading

eho1307 · 2024-12-12T19:18:13Z

proxmox/manifest.json

+      },
+      "metrics": {
+        "prefix": "proxmox.",
+        "check": "",


Is there a metric that is always submitted and represents that the integration is working? If so, please specify that here

proxmox/manifest.json

proxmox/metadata.csv

Co-authored-by: Erica Ho <[email protected]>

aliciascott · 2024-12-13T16:48:28Z

Thank you! I've created an editorial card for our team to review further.

iliakur

a couple small comments.

Not sure yet why the e2e tests are failing.

@aureleoules do you plan to add unit tests?

proxmox/datadog_checks/proxmox/__about__.py

iliakur · 2024-12-18T15:31:25Z

proxmox/assets/service_checks.json

Let's not submit a service check. We're slowly and gently deprecating those.

iliakur · 2024-12-18T15:33:28Z

proxmox/datadog_checks/proxmox/check.py

+
+    def check(self, _):
+        try:
+            headers = {"Authorization": f"PVEAPIToken={self.token_id}={self.token_secret}"}


What happens if token_id and token_secret are None?

there is a check in the init function for this

iliakur · 2024-12-18T15:36:11Z

proxmox/images/IMAGES_README.md

@eho1307 do we need this for this integration?

iliakur · 2024-12-18T15:36:49Z

proxmox/manifest.json

+    }
+  },
+  "author": {
+    "support_email": "[email protected]",


@aureleoules are we, Datadog, officially going to support this?

iliakur · 2024-12-18T15:37:46Z

proxmox/metadata.csv

+proxmox.cpu_current,gauge,60,percent,,Current CPU usage,1,proxmox,cpu_current,,host:proxmox
+proxmox.cpu_iowait,gauge,60,percent,,CPU iowait,1,proxmox,cpu_iowait,,host:proxmox
+proxmox.cpu_max,gauge,60,percent,,Max CPU usage,1,proxmox,cpu_max,,host:proxmox
+proxmox.disk_read,gauge,60,bytes,,Disk read,1,proxmox,disk_read,,host:proxmox


Suggested change

proxmox.disk_read,gauge,60,bytes,,Disk read,1,proxmox,disk_read,,host:proxmox

proxmox.disk_read,gauge,60,byte,,Disk read,1,proxmox,disk_read,,host:proxmox

Here and elsewhere. Also seconds -> second

proxmox/pyproject.toml

proxmox/tests/test_e2e.py

hestonhoffman

Left you some suggestions

hestonhoffman · 2025-01-06T18:27:58Z

proxmox/README.md

+To install the Proxmox integration, run the following Agent installation command and the steps below. For more information, see the [Integration Management](https://docs.datadoghq.com/agent/guide/integration-management/?tab=linux#install) documentation.
+
+```shell
+datadog-agent integration install datadog-vsphere==3.6.0


Is Vsphere correct?

good catch it should be datadog-proxmox

proxmox/README.md

proxmox/assets/dashboards/proxmox_overview.json

hestonhoffman · 2025-01-06T18:34:13Z

proxmox/assets/dashboards/proxmox_overview.json

+            "id": 6462887281714400,
+            "definition": {
+              "type": "note",
+              "content": "**Proxmox**\n\nThis dashboard provides an overview of your Proxmox and  the VMs running. ",


Suggested change

"content": "**Proxmox**\n\nThis dashboard provides an overview of your Proxmox and the VMs running. ",

"content": "**Proxmox**\n\nThis dashboard provides an overview of your Proxmox and VMs.",

Co-authored-by: Heston Hoffman <[email protected]>

Co-authored-by: Ilia Kurenkov <[email protected]>

Co-authored-by: Heston Hoffman <[email protected]> Co-authored-by: Ilia Kurenkov <[email protected]>

Add Proxmox integration

f2a3b0a

aureleoules requested review from a team as code owners December 6, 2024 09:18

aureleoules marked this pull request as draft December 6, 2024 09:18

aureleoules added 4 commits December 6, 2024 10:21

ci

0f4591a

models sync

12fab89

change contact

29e0644

Add codeowners entry

efc4cec

aureleoules force-pushed the aurele.oules/proxmox-integration branch from b9a2904 to efc4cec Compare December 6, 2024 09:51

eho1307 requested review from a team and JoshPatel13 and removed request for a team December 11, 2024 19:39

aureleoules marked this pull request as ready for review December 12, 2024 09:06

eho1307 requested changes Dec 12, 2024

View reviewed changes

aureleoules and others added 2 commits December 13, 2024 09:53

Apply suggestions from code review

301e133

Co-authored-by: Erica Ho <[email protected]>

Address more feedback

11501e2

aliciascott added the editorial review Waiting on a more in-depth review from a docs team editor label Dec 13, 2024

dd-dominic changed the title ~~Add Proxmox integration~~ Add Proxmox integration (ECOINT-50) Dec 16, 2024

iliakur requested changes Dec 18, 2024

View reviewed changes

hestonhoffman reviewed Jan 6, 2025

View reviewed changes

aureleoules and others added 3 commits January 16, 2025 11:05

Update proxmox/README.md

ea249fd

Co-authored-by: Heston Hoffman <[email protected]>

Update proxmox/datadog_checks/proxmox/__about__.py

fe465db

Co-authored-by: Ilia Kurenkov <[email protected]>

Apply suggestions from code review

5295a06

Co-authored-by: Heston Hoffman <[email protected]> Co-authored-by: Ilia Kurenkov <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Proxmox integration (ECOINT-50) #2555

Add Proxmox integration (ECOINT-50) #2555

aureleoules commented Dec 6, 2024 •

edited

Loading

eho1307 left a comment

eho1307 Dec 12, 2024

eho1307 Dec 12, 2024

aliciascott commented Dec 13, 2024

iliakur left a comment

iliakur Dec 18, 2024

iliakur Dec 18, 2024

aureleoules Jan 16, 2025

iliakur Dec 18, 2024

iliakur Dec 18, 2024

iliakur Dec 18, 2024

hestonhoffman left a comment

hestonhoffman Jan 6, 2025

aureleoules Jan 16, 2025

hestonhoffman Jan 6, 2025

	proxmox.disk_read,gauge,60,bytes,,Disk read,1,proxmox,disk_read,,host:proxmox
	proxmox.disk_read,gauge,60,byte,,Disk read,1,proxmox,disk_read,,host:proxmox

	"content": "Proxmox\n\nThis dashboard provides an overview of your Proxmox and the VMs running. ",
	"content": "Proxmox\n\nThis dashboard provides an overview of your Proxmox and VMs.",

Add Proxmox integration (ECOINT-50) #2555

Are you sure you want to change the base?

Add Proxmox integration (ECOINT-50) #2555

Conversation

aureleoules commented Dec 6, 2024 • edited Loading

What does this PR do?

Review checklist

Additional Notes

eho1307 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aliciascott commented Dec 13, 2024

iliakur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hestonhoffman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aureleoules commented Dec 6, 2024 •

edited

Loading