GET /ops/setserviceconfig
Description
Allows the following API Server configuration settings to be updated dynamically, without requiring a re-deployment:
- Filter logging levels
- Message payload logging
- Trace levels
- Data persistence settings
Filter Logging Levels
Each filter is responsible for logging its own message. It is set by default at the Relative Path/Web Service level, but can be overridden by configuring different logging levels for different filters.
For example, the following request will update the filter logging configuration for the http service Default Services. The Success and Fatal log messages will be recorded for each filter executed under the default relative path that has the Sucess and Fatal log settings enabled.
Message Payload Logging
Ability to configure the following payload logging settings on the specified relative path or WebService:
On Request Log the message payload when a request arrives. On Response Log the message payload before the response is sent back. On Remote Send Log the message payload before the request is sent using any Connection or Connect to URL filters deployed in any policies executed. On Remote Receive Log the message payload when the response is received using any Connection or Connect to URL filters deployed in any policies executed.
For example, the following request will update payload logging on remote send and receive for uri ‘/’ under Default Services:
Trace Levels
Tracel levels may be set globally for a process or at the port level.
The following trace levels are supported, in order of ascending verbosity (with the default being INFO):
- FATAL
- ERROR
- INFO
- DEBUG
- DATA
- INHERIT
For example, the following request will update the trace level to DEBUG for the Gateway:
http://localhost:8090/ops/setserviceconfig?process=VordelGateway&traceLevel=DEBUG
Data Persistence Settings
Data persistent settings may be set globally for a process or at the port level. The following data persistence settings are supported:
Record inbound transactions Select whether to record inbound message transactions received by the API Server. Record outbound transactions Select whether to record outbound message transactions sent from the API Server to remote hosts. Record circuit path Select whether to record the circuit path for the message transaction, which shows the filters that the message passes through. Record trace Select whether to record the trace output for the message transaction.
The following example updates recordInboundTransactions for global settings under the Gateway. This will ensure that all inbound transactions received by the API Server will be recorded:
The following example updates recordInboundTransactions for Port 8080 under Default Services. This will ensure that all inbound transactions received by the API Server on port 8080 will be recorded:
Resource URL
http://localhost:8090/ops/setserviceconfig
Parameters
| process | mandatory | The name of the process to update. |
| httpService | optional | The name of the HTTP Service to update. |
| uri | optional | The Relative path to update. |
| webService | optional | The WebService to update. Note uri (see above) and webService are mutually exclusive. |
| port | conditional | The Port to update. Note port, uri (and webService, see above) are mutually exclusive. |
| enable | optional | Enables/disables the Relative Path, Web Service or Port. |
| logFatal | optional | New logFatal value. Specifies whether or not filters should log Fatal messages. |
| logFailure | conditional | New logFailure value. Specifies whether or not filters should log Failure messages. |
| logSuccess | optional | New logSuccess value. Specifies whether or not filters should log Success messages. |
| payloadOnRequest | optional | New payloadOnRequest value. Specifies whether or not a payload should be logged when a request arrives. |
| payloadOnResponse | optional | New payloadOnResponse value. Specifies whether or not a payload should be logged when a response is sent back to the client. |
| payloadOnRemoteSend | optional | New payloadOnRemoteSend value. Specifies whether or not a payload should be logged when sending a request to a remote host. |
| payloadOnRemoteReceive | optional | New payloadOnRemoteReceive value. Specifies whether or not a payload should be logged when receiving a response from a remote host. |
| useSystemSettings | optional | New useSystemSettings value. Specifies whether or not system-level settings for the operations monitor are employed. |
| recordInboundTransactions | optional | New recordInboundTransactions value. Specifies whether or not inbound transactions should be logged by the operations monitor. |
| recordOutboundTransactions | optional | New recordOutboundTransactions value. Specifies whether or not inbound transactions should be recorded by the operations monitor. |
| recordCircuitPath | optional | New recordCircuitPath value. Specifies whether or not the circuitPath should be recorded by the operations monitor. |
| recordTrace | optional | New recordTrace value. Specifies whether or not the trace messages should be recorded by the operations monitor. |
| traceLevel | optional | New Trace Level value. Specifies the trace level either at the Process Level, or at the Port level, depending on which of the port or process parameters are specified. Can be one of the following values:
|
Response Codes
| Response Code | Description |
|---|---|
| 200 | Success |