You can configure the Prometheus Operator ServiceMonitor to automatically scrape Offline Mediation Controller metrics and Offline Mediation Controller REST Services Manager metrics. For more information about Prometheus Operator and ServiceMonitors, see the prometheus-operator documentation on the GitHub website (https://github.com/prometheus-operator/prometheus-operator/tree/main/Documentation/getting-started).

To enable the automatic scraping of Offline Mediation Controller metrics:

1. Install Prometheus Operator on your cloud native environment.

2. In your override-values.yaml file for oc-cn-ocomc, set the following keys:

   • ocomcCore.ocomc.nodeManagerConfigurations.serviceMonitor.enabled: Set this key to true.

   • ocomcCore.ocomc.nodeManagerConfigurations.serviceMonitor.interval: Set this to the interval at which to scrape metrics. The default is 10s.

   • ocomcCore.ocomc.nodeManagerConfigurations.serviceMonitor.labels.app: Set this to the app label you want applied to the ServiceMonitor resource. This label is used by Prometheus to discover the ServiceMonitor via label selectors.

   • ocomcCore.ocomc.nodeManagerConfigurations.serviceMonitor.labels.release: Set this to the release label you want applied to the ServiceMonitor resource. This label is used by Prometheus to discover the ServiceMonitor via label selectors.

   • ocomcCore.ocomc.nodeManagerConfigurations.metrics.service.type: Set this to the service type, such as NodePort or ClusterIP. The default is ClusterIP.

   • (For REST Services Manager) ocomcRSM.rsm.serviceMonitor.enabled: Set this key to true.

3. Run the helm upgrade command to update the Offline Mediation Controller Helm release:

   helm upgrade ReleaseName oc-cn-ocomc --values OverridingValuesFile -n NameSpace 

   where:

   • ReleaseName is the release name, which is used to track the installation instance.

   • OverrideValuesFile is the path to a YAML file that overrides the default configurations in the chart's values.yaml file.

   • NameSpace is the namespace in which to create Offline Mediation Controller Kubernetes objects.

The Offline Mediation Controller package includes sample Grafana Dashboard templates that you can use for visualizing metrics. To use the sample dashboards, import the following JSON files from the OMC_home/sampleData/dashboards directory into Grafana:

• OCOMC_JVM_Dashboard.json: This dashboard lets you view JVM-related metrics for Offline Mediation Controller.

• OCOMC_Node_Manager_Summary.json: This dashboard lets you view NAR processing metrics for the Node Manager.

• OCOMC_Node_Summary.json: This dashboard lets you view NAR processing metrics for all nodes.

• OCOMC_Summary_Dashboard.json: This dashboard lets you view NAR-related metrics for all Offline Mediation Controller components.

• OCOMC_RSM_JVM_Dashboard.json: This dashboard lets you view JVM-related metrics for Offline Mediation Controller RSM.

For information about importing dashboards, see "Manage Dashboards" in the Grafana Dashboards documentation.

You can use various metrics to monitor the performance and health of Offline Mediation Controller REST Services Manager.

Table 12-1 describes the metrics mapped to their variable names in the /metrics endpoint response.

To set up the REST Services Manager Request Automation feature in your Offline Mediation Controller cloud native deployment:

1. In your override-values.yaml file for oc-cn-ocomc-rsm, set the rsm.jobs.requestAutomation.enabled key to true.

2. Configure the following keys under rsm.jobs.requestAutomation.config:

   • apiUrl: Set this to the URL of your Offline Mediation Controller REST Services Manager service, such as http://ocomc-rsm:8080.

   • payloadFile: Specify the absolute path to your workflow payload JSON file.

   • loggingDIr: Define the directory where log files should be written.

   • (Optional) rsmOAuthToken: Set this to the REST Services Manager OAuth 2.0 token.

   The following shows an example configuration:

   jobs:
     requestAutomation:
       enabled: true
       config:
         apiUrl: "http://ocomc-rsm:8080"
         payloadFile: "/app/config/workflow-payload.json"
         loggingDir: "/app/volumes/ocomc-ext/logs

3. Create a JSON workflow payload file following the workflow file syntax. See "Creating a Workflow Payload File" for details.

4. Move the JSON workflow payload file to the directory specified in the payloadFile key.

5. Run a helm install or helm upgrade command to deploy your changes.

The workflow payload file defines your automation workflow in JSON format.

The following is an example of the workflow file structure:

{
  "workflow": {
    "flow": [
      {
        "id": "UPLOAD_IMPORT_FILE_ACTION",
        "request": "UPLOAD_IMPORT_FILE",
        "onResponse": {
          "environment": {
            "IMPORT_ID": "/importId"
          }
        }
      },
      {
        "id": "START_IMPORT_ACTION",
        "request": "START_IMPORT",
        "onResponse": {
          "statusMapping": {
            "2**": ["CHECK_IMPORT_COMPLETION_ACTION"]
          }
        }
      }
    ]
  },
  "headers": {},
  "environment": {},
  "requests": [
    {
      "id": "UPLOAD_IMPORT_FILE",
      "method": "POST",
      "uri": "/imports/uploadImportFile",
      "headers": {},
      "multipartForm": {
        "configurationFile": "FILE::/path/to/export.xml"
      }
    },
    {
      "id": "START_IMPORT",
      "method": "POST",
      "uri": "/imports/{{ENV:IMPORT_ID}}/tasks",
      "headers": {},
      "payload": {}
    }
  ]
}

The following is a breakdown of the syntax used within the workflow file, covering the key elements and options.

Table 12-2 describes the structure of the workflow section, which defines the sequence of actions to be executed.

Table 12-3 describes the elements used in the OnResponse section to handle API responses and determine subsequent actions.

"onResponse": {
  "environment": {
    "IMPORT_ID": "/importId"
  }
}

"statusMapping": {
  "5**": ["ABORT"]
}

"retry": {
  "maxRetries": "5",
  "interval": "10000"
}

"dataMapping": [
  {
    "path": "/importTaskItem/taskFinished",
    "equals": "true",
    "then": []
  },
  {
    "path": "/importTaskItem/taskFinished",
    "equals": "false",
    "then": ["RETRY"]
  }
]

Table 12-4 describes the elements required to define individual API requests that can be referenced within a workflow.

When you install a Helm chart, it creates a release. A release contains Kubernetes objects, such as ConfigMap, Secret, Deployment, Pod, PersistentVolume, and so on. Not every object is up and running immediately. Some objects have a start delay, but the Helm install command completes immediately.

To track the status of a release and its Kubernetes objects, enter this command:

helm status ReleaseName -n Namespace

where:

• ReleaseName is the name you assigned to this installation instance.

• NameSpace is the namespace in which the Offline Mediation Controller Kubernetes objects reside.

To update any key value after a release has been created, enter this command. This command updates or re-creates the impacted Kubernetes objects, without impacting other objects in the release. It also creates a new revision of the release.

helm upgrade ReleaseName oc-cn-ocomc-helm-chart --values OverridingValueFile --values NewOverridingValueFile -n Namespace 

where:

• ReleaseName is the name you assigned to this installation instance.

• OverridingValueFile is the path to the YAML file that overrides the default configurations in the oc-cn-ocomc/values.yaml file.

• NewOverridingValueFile is the path to the YAML file that has updated values. The values in this file are newer than those defined in values.yaml and OverridingValueFile.

• Namespace is the namespace in which the Offline Mediation Controller Kubernetes objects reside.

Helm keeps track of the revisions you make to a release. To check the revision for a particular release, enter this command:

helm history ReleaseName -n Namespace

where:

• ReleaseName is the name you assigned to this installation instance.

• Namespace is the namespace in which the Offline Mediation Controller Kubernetes objects reside.

To roll back a release to any previous revision, enter this command:

helm rollback ReleaseName RevisionNumber -n Namespace

where:

• ReleaseName is the name you assigned to this installation instance.

• RevisionNumber is the value from the Helm history command.

• Namespace is the namespace in which the Offline Mediation Controller Kubernetes objects reside.