Diagnostics and metadata

You can configure AVEVA Adapters to produce and store diagnostics data at a designated health endpoint, and to send metadata for created streams. For more information about available diagnostics data, see Diagnostics and Egress. For more information about available metadata and what metadata are sent per metadata level, see Metadata.

Configure general

1. Start any of the Configuration tools capable of making HTTP requests.

2. Run a PUT command to the following endpoint, setting EnableDiagnostics to either true or false, MetadataLevel to None, Low, Medium, or High and HealthPrefix to a string or null: http://localhost:5590/api/v1/configuration/system/general

   Note: 5590 is the default port number. If you selected a different port number, replace it with that value.

   Example using curl:

   curl -d "{ \"EnableDiagnostics\":true, \"MetadataLevel\":Medium, \"HealthPrefix\":\"Machine1\" }" -X PUT "http://localhost:5590/api/v1/configuration/system/general"

General schema

The full schema definition for the general configuration is in the System_General_schema.json file located in one of the following folders:

Windows: %ProgramFiles%\OSIsoft\Adapters\\Schemas

Linux: /opt/OSIsift/Adapters//Schemas

General parameters

The following parameters are available for configuring general:

Example

Retrieve the general configuration

Example using curl:

curl -X GET "http://localhost:{port}/api/v1/configuration/system/general"

Sample output:

{

"EnableDiagnostics": true,

"MetadataLevel": "Medium",

"HealthPrefix": "Machine1"

}

REST URLs