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

Updated Experiment JVM doc #266

Merged
merged 5 commits into from
Nov 11, 2024
Merged

Updated Experiment JVM doc #266

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d8b1a66
Updated Experiment JVM doc
zhukaihan Sep 10, 2024
30f65b0
Update content/collections/experiment-sdks/en/experiment-jvm.md
zhukaihan Sep 11, 2024
dad38b9
Update content/collections/experiment-sdks/en/experiment-jvm.md
zhukaihan Sep 11, 2024
bb44453
Update content/collections/experiment-sdks/en/experiment-jvm.md
zhukaihan Sep 11, 2024
a0aaca5
Apply suggestions from code review
zhukaihan Oct 22, 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
7 changes: 5 additions & 2 deletions content/collections/experiment-sdks/en/experiment-jvm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,8 @@
| `apiKey` | required | The server [deployment key](/docs/experiment/data-model#deployments) which authorizes fetch requests and determines which flags should be evaluated for the user. |
| `config` | optional | The client [configuration](#configuration) used to customize SDK client behavior. |

{{partial:admonition type="tip" heading="Flag polling interval"}}
Use the `flagConfigPollingIntervalMillis` [configuration](#configuration-1) to determine the time flag configs take to update once modified (default 30s).
{{partial:admonition type="tip" heading="Flag streaming"}}
Use the `streamUpdates` [configuration](#configuration-1) to get flag config updates pushed to SDK (default false), instead of polling every `flagConfigPollingIntervalMillis` milliseconds. The time for SDK to receive the update after saving is generally under 1 second. It will fallback to polling if streaming failed. Configure `flagConfigPollingIntervalMillis` [configuration](#configuration-1) to determine the time flag configs take to update once modified (default 30s) as well for fallback.

Check warning on line 373 in content/collections/experiment-sdks/en/experiment-jvm.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Will] Future tense! Avoid using 'will fallback'.

Raw Output:
{"message": "[Amplitude.Will] Future tense! Avoid using 'will fallback'.", "location": {"path": "content/collections/experiment-sdks/en/experiment-jvm.md", "range": {"start": {"line": 373, "column": 274}}}, "severity": "WARNING"}

Check warning on line 373 in content/collections/experiment-sdks/en/experiment-jvm.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.ComplexWords] Consider using 'decide' or 'find' instead of 'determine'.

Raw Output:
{"message": "[Amplitude.ComplexWords] Consider using 'decide' or 'find' instead of 'determine'.", "location": {"path": "content/collections/experiment-sdks/en/experiment-jvm.md", "range": {"start": {"line": 373, "column": 401}}}, "severity": "WARNING"}
zhukaihan marked this conversation as resolved.
Show resolved Hide resolved
{{/partial:admonition}}

#### Configuration
Expand All @@ -391,6 +391,9 @@
| `flagConfigPollingIntervalMillis` | The interval to poll for updated flag configs after calling [`Start()`](#start) | `30000` |
| `flagConfigPollerRequestTimeoutMillis` | The timeout for the request made by the flag config poller | `10000` |
| `assignmentConfiguration` | Enable automatic assignment tracking for local evaluations. | `null` |
| `streamUpdates` | Enable streaming to replace polling for receiving flag config updates. Instead of polling every second, our servers push updates to SDK generally within a second. If stream fails for any reason, it will fallback to polling automatically and retry streaming after some interval. | `false` |

Check warning on line 394 in content/collections/experiment-sdks/en/experiment-jvm.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Will] Future tense! Avoid using 'will fallback'.

Raw Output:
{"message": "[Amplitude.Will] Future tense! Avoid using 'will fallback'.", "location": {"path": "content/collections/experiment-sdks/en/experiment-jvm.md", "range": {"start": {"line": 394, "column": 219}}}, "severity": "WARNING"}
zhukaihan marked this conversation as resolved.
Show resolved Hide resolved
| `streamServerUrl` | The stream server url to stream from. | `https://stream.lab.amplitude.com` |

Check warning on line 395 in content/collections/experiment-sdks/en/experiment-jvm.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'url'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'url'?", "location": {"path": "content/collections/experiment-sdks/en/experiment-jvm.md", "range": {"start": {"line": 395, "column": 41}}}, "severity": "WARNING"}
zhukaihan marked this conversation as resolved.
Show resolved Hide resolved
| `streamFlagConnTimeoutMillis` | The timeout for establishing a valid flag config stream. This includes time for a connection to be established to stream server and time for receiving initial flag configs. | `1500` |

Check warning on line 396 in content/collections/experiment-sdks/en/experiment-jvm.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Passive] 'be established' looks like passive voice.

Raw Output:
{"message": "[Amplitude.Passive] 'be established' looks like passive voice.", "location": {"path": "content/collections/experiment-sdks/en/experiment-jvm.md", "range": {"start": {"line": 396, "column": 131}}}, "severity": "WARNING"}
zhukaihan marked this conversation as resolved.
Show resolved Hide resolved
| `cohortSyncConfig` | Configuration to enable cohort downloading for [local evaluation cohort targeting](#local-evaluation-cohort-targeting). | `null` |

**AssignmentConfiguration**
Expand Down
Loading