Health endpoints

You can configure adapters to produce and store health data at a designated health endpoint. You can use health data to ensure that your adapters are running properly and that data flows to the configured OMF endpoints.

For more information about adapter health, see Health.

Configure health endpoint

A health endpoint designates an OMF endpoint where adapter health information is sent. You can configure multiple health endpoints.

Complete the following steps to configure health endpoints. Use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/healthendpoints REST endpoint to initialize the configuration.

1. Using a text editor, create an empty text file.

2. Copy and paste an example configuration for health endpoints into the file.

   For sample JSON, see Health endpoints examples below.

3. Update the example JSON parameters for your environment.

   For a table of all available parameters, see Health endpoints parameters below.

4. Save the file. For example, as ConfigureHealthEndpoints.json.

5. Open a command line session. Change directory to the location of ConfigureHealthEndpoints.json.

6. Enter the following cURL command (which uses the PUT method) to initialize the health endpoint configuration.

   curl -d "@ConfigureHealthEndpoints.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/system/healthendpoints"

   Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.

   For a list of other REST operations you can perform, like updating or replacing a health endpoints configuration, see REST URLs below.

Health endpoints schema

The full schema definition for the health endpoint configuration is in the System_HealthEndpoints_schema.json file located in one of the following folders:

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

Linux: /opt/OSIsoft/Adapters//Schemas

Health endpoint parameters

The following parameters are available for configuring health endpoints:

Examples

CONNECT data services endpoint

[

{

"id": "CONNECT data services",

"endpoint": "https://<CONNECT data services OMF endpoint>",

"clientId": "<clientid>",

"clientSecret": "<clientsecret>"

}

]

PI Web API endpoint

[

{

"id": "PI Web API",

"endpoint": "https://<pi web api server>:<port>/piwebapi/omf/",

"userName": "<username>",

"password": "<password>"

}

]

Note: When you use an adapter with a PI Web API health endpoint, the AF structure is required. If the elements are deleted, the adapter recreates the elements; if the account used to authenticate to the PI Web API has its permissions removed on the AF Server, the adapter retries sending health data to the PI Web API until the permissions are restored.

REST URLs

Note: Replace Id with the Id of the health endpoint.