Server dashboard functionality
This documentation describes the functionality of server dashboard.
About this task
The functions you can perform using server dashboard include the following:
- List the defined servers.
- Create a new server definition.
- Edit a server definition.
- Set the values of configuration variables for the server group to which the server belongs.
- See run history statistics in graphical form (illustrated with pie and bar charts) for a specified time.
- List all the packages/endpoints deployed to the server:
- To order on certain columns. (For example, package, component name).
- To provide package status (available or stopped).
- To report statistics for each endpoint, such as number of successes, failures, and total runs.
- To show information about whether the endpoint is scheduled or not, and what is the schedule.
- Stop or Start any package.
- Scheduling of an endpoint, including removing the schedule entirely.
- Run an endpoint on demand.
- Provide input file or data if the endpoint has an input.
- Retrieve output data if the endpoint has an output.
- Set flow variables and other query parameters in the request.
- Refresh server dashboard page manually or automatically.
- Clicking on an endpoint will offer the following options:
- Change schedule
- Remove schedule (only shown if the endpoint is scheduled)
- Run now
By default, the statistics will only refresh when a 'refresh' button is pressed. The UI should also support enabling an 'auto refresh' toggle which will then cause the UI to refresh the data on a fixed period (for example, every 5 seconds).
The endpoint statistics come with an expiration time, governed by specific
configuration parameters outlined in the config.yaml file. These parameters are:
- /redis/persistence/maxStatisticCount: This parameter sets the upper limit for the retention of flow instances in the statistics. The default value is 100,000.
- /redis/persistence/statusExpiration: This parameter dictates the duration before the JSON status key expires. The default expiration period is 60 days.
Note: If you modify these configuration parameters, it is necessary to restart
the REST server for the changes to take effect.