Enable OpenEdge Command Center agent to collect performance metrics of OpenEdge database

You can enable the OpenEdge Command Center agent to collect performance metrics of an OpenEdge database by specifying details in the otagentoedb.yaml file. The file is present in the conf folder of the OpenEdge Command Center agent installation.

Follow these steps to enable the agent to collect performance metrics for an OpenEdge database:

  1. Open the otagentoedb.yaml file in an editor.
  2. In the exporter node of the otagentoedb.yaml file, provide values for the following properties of the OpenEdge Command Center agent connection to the OTel Collector:
    • name—A name for the OpenTelemetry exporter. Ensure that the value is set to otlp.
    • endpoint—The target URL to which the exporter sends the performance metrics data. The OTel Collector receives the metrics data at this endpoint. Make sure to use the same endpoint when you configure the OTel Collector.
    • protocol—The transport protocol used to export the metrics data. Use grpc as the value for this property.
    • timeout—The maximum time the OTLP exporter waits for each batch export.
    • connectionretry—The number of times the OpenEdge Command Center agent tries to connect to the OTel Collector in case of a connection failure. To know more about the impact of connection failure and how the connection is restored, see Performance impact and resilience of collecting performance metrics.
  3. In the oedbInstances node, provide values for the following properties of the OpenEdge databases to be monitored:
    • dbname—The name of the database to be monitored.
    • host—The IP address of the database host.
    • port—The port on which the database is running.
    • user—The username of the database user.
      Note: You must provide username of either a DBA user or a user with the SELECT permissions on the following virtual system tables (VSTs):
      • _ActSummary
      • _ActRecord
      • _ActPWs
      • _ActBILog
      • _ActAILog
      • _ActBuffer
    • password—The password of the database user.
      Note: The password can be in cleartext or encoded using the genpassword utility, which is a password encryption utility provided with the OpenEdge database.
    • metricsregex—A regular expression (regex) to ensure that only the specified database performance metrics whose names match the pattern you have configured are collected. When left blank, the agent captures all the defined metrics.
      Note: You can use only the * quantifier to create a regular expression.
    • otherdbconnparams—Any other optional SQL JDBC connection parameters to be used for connecting to the database, separated by a semicolon (;).
    • dbschedule—The time interval at which the agent must capture the metrics data. This property works in conjunction with the dbduration property. OpenTelemetry limits the frequency for posting data to a maximum of two times per minute or once every 30 seconds. Progress recommends to send metrics data once per minute.
    • dbduration—The unit of time interval at which the agent must capture the metrics data. The possible values can be seconds, minutes, hours, or days. This property works in conjunction with the dbschedule property.
    Note: You can provide details of multiple OpenEdge databases on your machine under the oedbInstances node and collect their metrics data using a single OpenEdge Command Center agent.
  4. Save the changes made to the otagentoedb.yaml file.

Here is a sample otagentoedb.yaml file with details of two OpenEdge database instances:

exporter:
  name: "otlp"
  endpoint: "http://10.248.0.150:4317"
  protocol: "grpc"
  timeout: 10
  connectionretry: 20


oedbInstances:
-  dbname: sports
   host: localhost
   port: 2022
   user: ss1
   password: ss1
   metricsregex:
   otherdbconnparams:
   dbschedule: 30
   dbduration: SECONDS
-  dbname: testdb2
   host: localhost
   port: 3111
   user: admin
   password: xxx
   metricsregex: 
   otherdbconnparams: 
   dbschedule: 30
   dbduration: SECONDS

After updating the otagentoedb.yaml file, restart the OpenEdge Command Center agent.