topic Re: DB Query Extension in Extensions

Database Query Extension

RodrigoBiaggio — Thu, 05 Jun 2025 09:23:24 GMT

Guys, please, I need some help on an extension. I need to create a plugin that executes a query against a MySQL database. Should I create an ActiveGate Extension or Oneagent extension? Does anyone have an example or any documentation that shows a model?

Re: DB Query Extension

Julius_Loman — Fri, 01 Oct 2021 05:13:13 GMT

The answer is - it depends on the requirements. If it's for a single purpose, I'd consider writing a simple script that will execute queries using MySQL command line client and push the metrics using metric ingestion or events using API. This is much simpler than the writing extension.

If you still need to create an extension, keep in mind:

OneAgent extensions can only push data to process groups residing on the same host where they run. (so you must have Oneagent on the DB host).
ActiveGate extension creates new entities (custom devices). You can somehow also push data to existing entities based on metadata.

For samples see here in the docs and for inspiration, you can look into the code of the MySQL extension that is shipped with the OneAgent itself.

Re: DB Query Extension

RodrigoBiaggio — Fri, 01 Oct 2021 12:36:43 GMT

Julius, sorry, but just a question. To run the first option you mentioned, I would need the agent installed on the database servers, right? My question is how I would schedule this script execution and sending the metrics, which makes me wonder.

Re: DB Query Extension

Julius_Loman — Fri, 01 Oct 2021 13:24:52 GMT

@RodrigoBiaggio you have actually two options here for sending.

You have OneAgent on the host from where you will send the metrics -> send them using local ingestion interface
You don't have OneAgent on the host -> send them using API You will need to have an API token created in this case and typically you will want to set the dt.entity in the output.

Depending on your DB you can execute it remotely.
Regarding scheduling - use cron or systemd on Linux for example, Windows scheduler on windows. It's really up to you. You can also run a daemon in and process it in a loop.

Re: DB Query Extension

Enrico_F — Fri, 10 Jun 2022 06:07:14 GMT

FYI: There is an officially supported plugin providing that functionality: Custom Database Queries.

Re: DB Query Extension

GaryB — Mon, 20 Jun 2022 17:10:35 GMT

How are database credentials stored and maintained with this plugin?

Re: DB Query Extension

Enrico_F — Tue, 21 Jun 2022 18:02:31 GMT

As with any custom extension that implements the Extensions SDK the instance config (including DB credentials in this case) can be managed either via the UI (via "endpoint config" in the custom extension settings) or programmatically via the config API (via GET/PUT/DELETE /api/config/v1/extensions/{id}/instances/{configurationId}).

Re: DB Query Extension

Mike_L — Tue, 21 Jun 2022 18:19:01 GMT

They are stored encrypted in the Dynatrace database. It is then transferred in a secure way to the ActiveGate and never leave the ActiveGate’s memory.