Skip to content

Script Development / TrueWatch

The TrueWatch Connector primarily provides a DataWay object for data writing and encapsulation of OpenAPI.

DFF.CONN(...) parameters are as follows:

Parameter Type Required / Default Description
connector_id str Required Connector ID

For OpenAPI documentation, refer to:

.dataway

The dataway attribute is the DataWay operation object corresponding to the current TrueWatch, and its usage is the same as directly creating a DataWay Connector operation object.

Example
1
status_code, result = truewatch.dataway.write_by_category(category='metric', measurement='Service Monitoring', tags={'service': 'mysql'}, fields={'mem': 10})

For complete content, refer to:

.is_api_key_valid / .is_api_key_match

The is_api_key_valid / is_api_key_match attribute returns whether the current Connector's API Key is valid:

Example
1
print(truewatch.is_api_key_valid)
Output Example
1
True

.workspace

The workspace attribute returns the current workspace information:

Example
1
2
import json
print(json.dumps(truewatch.workspace, indent=2))
Output Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "uuid"        : "wksp_xxxxx",
  "name"        : "xxxxx",
  "rpName"      : "rp2",
  "language"    : "en",
  "timezone"    : "",
  "bossStation" : "HK",
  "billingState": "normal",
  "versionType" : "pay",
  "token"       : "tkn_xxxxx",
  "cliToken"    : "wkcli_xxxxx",
  "<Other fields omitted>": "..."
}

.workspace_uuid

The workspace_uuid attribute returns the current workspace UUID:

Example
1
print(truewatch.workspace_uuid)
Output Example
1
wksp_xxxxx

.workspace_token

The workspace_token attribute returns the current workspace Token:

Example
1
print(truewatch.workspace_token)
Output Example
1
tkn_xxxxx

.workspace_language

The workspace_language attribute returns the current workspace language:

Example
1
print(truewatch.workspace_language)
Output Example
1
zh

.do_get(...)

Used to make a GET request to the TrueWatch OpenAPI, with the following parameters:

Parameter Type Required / Default Description
path str Required Path
query dict Parameters
Example
1
2
3
4
import json

result = truewatch.do_get('/api/v1/workspace/get')
print(json.dumps(result, indent=2))
Output Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "uuid"        : "wksp_xxxxx",
  "name"        : "xxxxx",
  "rpName"      : "rp1",
  "language"    : "en",
  "timezone"    : "",
  "bossStation" : "HK",
  "billingState": "normal",
  "versionType" : "pay",
  "token"       : "tkn_xxxxx",
  "cliToken"    : "wkcli_xxxxx",
  "<Other fields omitted>": "..."
}

.do_post(...)

Used to make a POST request to the TrueWatch OpenAPI, with the following parameters:

Parameter Type Required / Default Description
path str Required Path
query dict Parameters
body dict JSON body
Example
1
2
3
4
body = {
    'name': 'New Name'
}
result = truewatch.do_post('/api/v1/workspace/modify', body=body)

Nodes

The TrueWatch system is equipped with a multi-node distributed architecture. When creating a Connector, the target node must be precisely specified to ensure normal function invocation.

DataFlux Func adopts a versioned node list solidification mechanism to achieve compatibility with fully offline usage scenarios — each version release will synchronously save the latest TrueWatch node list at that time, ensuring stable operation in offline environments.

Due to this mechanism, if TrueWatch adds new nodes subsequently, it may happen that the DataFlux Func version node list is not updated in time. It is recommended that users pay attention to version iteration information. If the latest node functions are needed, upgrading to the latest version of DataFlux Func can provide full support.


If encountering the above situation, the following steps can be taken to complete the new node configuration:

  1. Information Query: Visit the specified address to obtain the complete configuration parameters of the newly added TrueWatch nodes;
  2. Manual Deployment: Select the "Private Deployment" mode and manually fill in the queried node information into the corresponding fields of the system to complete the configuration.

It is recommended to confirm the accuracy of the parameters before operation to ensure compatibility with the current environment and guarantee deployment effectiveness.

The currently available node list is as follows:

Node Name Address
Fetching the latest node list...