Skip to content

Commit

Permalink
Readme, changelog and package.json updates, touch #456.
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulDalek committed Jul 11, 2024
1 parent 6e24a08 commit a1b5e93
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 92 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ _Enhancements:_
- The `uncaughtException` handler now kills the pool, browser, and terminates the process with exit code 1, when enabled.
- The browser instance should be correctly closed now when an error occurs during pool creation.
- Corrected error handling and response sending in the `/change_hc_version.js` route.
- Corrected the `handleResources` function.
- Corrected the `handleResources` function and moved to the `chart.js` module.
- Corrected samples, test scenarios, and test runners.
- Bumped versions of most packages, with an updating deprecated `Puppeteer` from `v21.1.1` to latest.
- Added missing Highcharts modules to stay up-to-date with the latest updates.
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -731,8 +731,9 @@ This package supports both CommonJS and ES modules.

- `{boolean} noLogo`: If **true**, only prints version information without the logo.

- `printUsage(noLogo)`: Prints the usage information for CLI arguments. If required, it can list properties recursively.
- `printUsage(defaultConfig, noLogo)`: Prints the usage information for CLI arguments. If required, it can list properties recursively.

- `{Object} defaultConfig` - Default configuration object for reference.
- `{boolean} noLogo`: If **true**, only prints version information without the logo.

- `printVersion()`: Prints the Highcharts Export Server logo, version and license information.
Expand All @@ -751,18 +752,20 @@ When enabled, a WebSocket connection will be established on Export Server startu

Once the connection is established, the chart data from each request to the Export Server is passed to the telemetry module, which filters the data based on a JSON file that specifies which data needs to be sent. This file can be found under `./lib/schemas/telemetry.json` and can be modified as needed, but the proposed structure must be maintained. It is also possible to send the entire object of chart options by setting the `gatherAllOptions` option to **true**.

Data processed in this way is saved in an object that collects information about requests for a certain period and is batch sent to the WebSocket server at specified intervals.
Data processed in this way is saved in an object that collects information about requests for a certain period and is batch sent to the WebSocket server at specified intervals. After sending, the object is cleared of request data and gathers new data until the next interval.

Please refer to the [Configuration](https://github.com/highcharts/node-export-server?tab=readme-ov-file#configuration) section for descriptions of the options.

## Additional Notes

- In order for the heartbeat mechanism between the WebSocket client and server to work correctly, the `pingTimeout` must be set to a higher value in milliseconds than its equivalent in the WebSocket server.
- In order for the heartbeat mechanism between the WebSocket client and server to work correctly, the `pingTimeout` should be set to a higher value in milliseconds than its equivalent in the WebSocket server.

- Setting **0** for any of the interval/timeout-related options (`pingTimeout`, `reconnectInterval`, or `messageInterval`) will disable that option. Bear in mind, however, that disabling `pingTimeout` might result in WebSocket clients not being terminated if no response is received from the server.

- Disabling `pingTimeout` will also disable the reconnect mechanism.

- When using a self-signed certificate (for example, for testing purposes), the `rejectUnauthorized` option should be disabled. Otherwise, it will result in an error and the connection to the WebSocket server will fail.

# Tips, Tricks & Notes

## Note About Version And Help Information
Expand Down
Loading

0 comments on commit a1b5e93

Please sign in to comment.