Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ci-trap-web for web based data collection #5

Merged
merged 2 commits into from
Apr 8, 2024
Merged

Add ci-trap-web for web based data collection #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d592bc
feat: Add ci-trap-web for web based data collection
Apr 2, 2024
74e74ca
chore: Upgrade package version to 1.0.1
Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,18 +263,21 @@ Stop data collection

#### ReporterConfigurationType

| Prop | Type | Description |
| ---------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`apiKeyName`** | <code>string</code> | Name of the api key sent in the HTTP header |
| **`apiKeyValue`** | <code>string</code> | Value of the api key sent in the HTTP header |
| **`cachedTransport`** | <code>boolean</code> | Whether to cache data packets on the device when connection to the remote server cannot be established. |
| **`compress`** | <code>boolean</code> | Whether to compress the data sent to the server. If true GZIP compression is used. |
| **`connectTimeout`** | <code>number</code> | The connect timeout for the HTTP transport in milliseconds. |
| **`interval`** | <code>number</code> | The time interval the reporter task runs with. |
| **`maxFileCacheSize`** | <code>number</code> | About how much space on the device can be used to store unsent data packets. The lib might use a little more space than this value in case the data packet size exceeds the remaining space. |
| **`readTimeout`** | <code>number</code> | The read timeout for the HTTP transport in milliseconds. |
| **`sessionId`** | <code>string</code> | The persistent session id to send in the header frame. Must be set manually with a custom config class! |
| **`url`** | <code>string</code> | The URL to send the data packets to. |
| Prop | Type | Description |
| ---------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`apiKeyName`** | <code>string</code> | Name of the api key sent in the HTTP header |
| **`apiKeyValue`** | <code>string</code> | Value of the api key sent in the HTTP header |
| **`bufferSizeLimit`** | <code>number \| null</code> | Default maximum buffer size in number of events (in web collector) |
| **`bufferTimeout`** | <code>number \| null</code> | Default timeout for sending the buffer automatically in milliseconds (in the web collector) |
| **`cachedTransport`** | <code>boolean</code> | Whether to cache data packets on the device when connection to the remote server cannot be established. |
| **`compress`** | <code>boolean</code> | Whether to compress the data sent to the server. If true GZIP compression is used. |
| **`connectTimeout`** | <code>number</code> | The connect timeout for the HTTP transport in milliseconds. |
| **`idleTimeout`** | <code>number \| null</code> | Default idle timeout in milliseconds (in the web collector). |
| **`interval`** | <code>number</code> | The time interval the reporter task runs with. |
| **`maxFileCacheSize`** | <code>number</code> | About how much space on the device can be used to store unsent data packets. The lib might use a little more space than this value in case the data packet size exceeds the remaining space. |
| **`readTimeout`** | <code>number</code> | The read timeout for the HTTP transport in milliseconds. |
| **`sessionId`** | <code>string</code> | The persistent session id to send in the header frame. Must be set manually with a custom config class! |
| **`url`** | <code>string</code> | The URL to send the data packets to. |


### Enums
Expand Down
4 changes: 3 additions & 1 deletion example/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading