-
Notifications
You must be signed in to change notification settings - Fork 3
release initial launchdarkly observability packages #22
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3a11f24
release initial launchdarkly observability packages
Vadman97 715756b
add skeletons for package.json
Vadman97 32e57d2
update readmes
Vadman97 f5d8aa9
prettier
Vadman97 171cbe2
fix sdk names
Vadman97 fff572b
fix
Vadman97 f194337
configure token
Vadman97 22c8c53
remove provenance while private
Vadman97 ec93fb7
update readmes
Vadman97 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| #!/usr/bin/env bash | ||
| #!/bin/bash -ex | ||
| if $LD_RELEASE_IS_DRYRUN ; then | ||
| echo "Doing a dry run of publishing." | ||
| else | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # LaunchDarkly JavaScript Observability SDK for Browsers | ||
|
|
||
| [![NPM][browser-sdk-npm-badge]][browser-sdk-npm-link] | ||
| [![Actions Status][browser-sdk-ci-badge]][browser-sdk-ci] | ||
| [![Documentation][browser-sdk-ghp-badge]][browser-sdk-ghp-link] | ||
| [![NPM][browser-sdk-dm-badge]][browser-sdk-npm-link] | ||
| [![NPM][browser-sdk-dt-badge]][browser-sdk-npm-link] | ||
|
|
||
| # ⛔️⛔️⛔️⛔️ | ||
|
|
||
| > [!CAUTION] | ||
| > This library is a alpha version and should not be considered ready for production use while this message is visible. | ||
|
|
||
| # ☝️☝️☝️☝️☝️☝️ | ||
|
|
||
| <!-- | ||
| ## Install | ||
|
|
||
| ```shell | ||
| # npm | ||
| npm i @launchdarkly/observability | ||
|
|
||
| # yarn | ||
| yarn add @launchdarkly/observability | ||
| ``` | ||
| --> | ||
|
|
||
| ## Getting started | ||
|
|
||
| Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/javascript#getting-started) for instructions on getting started with using the SDK. | ||
|
|
||
| ## Verifying SDK build provenance with the SLSA framework | ||
|
|
||
| LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md). | ||
|
|
||
| ## About LaunchDarkly | ||
|
|
||
| - LaunchDarkly Observability provies a way to collect and send errors, logs, traces to LaunchDarkly. Correlate latency or exceptions with your releases to safely ship code. | ||
| - LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can: | ||
Vadman97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases. | ||
| - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?). | ||
| - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file. | ||
| - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). | ||
| - Disable parts of your application to facilitate maintenance, without taking everything offline. | ||
| - LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list. | ||
| - Explore LaunchDarkly | ||
| - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information | ||
| - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides | ||
| - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation | ||
| - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates | ||
|
|
||
| [browser-sdk-ci-badge]: https://github.com/launchdarkly/observability-sdk/actions/workflows/browser.yml/badge.svg | ||
| [browser-sdk-ci]: https://github.com/launchdarkly/observability-sdk/actions/workflows/browser.yml | ||
| [browser-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/observability.svg?style=flat-square | ||
| [browser-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/observability | ||
| [browser-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 | ||
| [browser-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/browser/docs/ | ||
| [browser-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/observability.svg?style=flat-square | ||
| [browser-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/observability.svg?style=flat-square | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| { | ||
| "name": "@launchdarkly/observability", | ||
| "version": "0.0.1", | ||
| "description": "Browser observability for your web app. Capture frontend metrics, errors, logs and traces.", | ||
| "keywords": [ | ||
| "launchdarkly", | ||
| "error monitoring", | ||
| "logging", | ||
| "tracing", | ||
| "metrics", | ||
| "debugging", | ||
| "observability", | ||
| "browser", | ||
| "library" | ||
| ], | ||
| "homepage": "https://github.com/launchdarkly/observability-sdk#readme", | ||
| "bugs": { | ||
| "url": "https://github.com/launchdarkly/observability-sdk/issues", | ||
| "email": "[email protected]" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "repository": { | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/launchdarkly/observability-sdk.git" | ||
| } | ||
| }, | ||
| "type": "module", | ||
| "main": "./dist/index.js", | ||
| "module": "./dist/index.js", | ||
| "unpkg": "./dist/index.umd.js", | ||
| "jsdelivr": "./dist/index.umd.js", | ||
| "types": "./dist/index.d.ts", | ||
| "exports": { | ||
| "types": "./dist/index.d.ts", | ||
| "unpkg": "./dist/index.umd.js", | ||
| "jsdelivr": "./dist/index.umd.js", | ||
| "import": "./dist/index.js", | ||
| "require": "./dist/index.js", | ||
| "default": "./dist/index.js" | ||
| }, | ||
| "files": [ | ||
| "dist" | ||
| ], | ||
| "size-limit": [ | ||
| { | ||
| "path": [ | ||
| "dist/*.js", | ||
| "!dist/*.umd.js" | ||
| ], | ||
| "limit": "256 kB", | ||
| "brotli": true | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # LaunchDarkly JavaScript Session Replay SDK for Browsers | ||
|
|
||
| [![NPM][browser-sdk-npm-badge]][browser-sdk-npm-link] | ||
| [![Actions Status][browser-sdk-ci-badge]][browser-sdk-ci] | ||
| [![Documentation][browser-sdk-ghp-badge]][browser-sdk-ghp-link] | ||
| [![NPM][browser-sdk-dm-badge]][browser-sdk-npm-link] | ||
| [![NPM][browser-sdk-dt-badge]][browser-sdk-npm-link] | ||
|
|
||
| # ⛔️⛔️⛔️⛔️ | ||
|
|
||
| > [!CAUTION] | ||
| > This library is a alpha version and should not be considered ready for production use while this message is visible. | ||
|
|
||
| # ☝️☝️☝️☝️☝️☝️ | ||
|
|
||
| <!-- | ||
| ## Install | ||
|
|
||
| ```shell | ||
| # npm | ||
| npm i @launchdarkly/session-replay | ||
|
|
||
| # yarn | ||
| yarn add @launchdarkly/session-replay | ||
| ``` | ||
| --> | ||
|
|
||
| ## Getting started | ||
|
|
||
| Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/javascript#getting-started) for instructions on getting started with using the SDK. | ||
|
|
||
| ## Verifying SDK build provenance with the SLSA framework | ||
|
|
||
| LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md). | ||
|
|
||
| ## About LaunchDarkly | ||
|
|
||
| - LaunchDarkly Session Replay provies a way to capture user sessions on your application to replay them in LaunchDarkly. Understand how users are interacting with your site and with new features you ship. | ||
| - LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can: | ||
| - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases. | ||
| - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?). | ||
| - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file. | ||
| - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). | ||
| - Disable parts of your application to facilitate maintenance, without taking everything offline. | ||
| - LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list. | ||
| - Explore LaunchDarkly | ||
| - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information | ||
| - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides | ||
| - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation | ||
| - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates | ||
|
|
||
| [browser-sdk-ci-badge]: https://github.com/launchdarkly/observability-sdk/actions/workflows/browser.yml/badge.svg | ||
| [browser-sdk-ci]: https://github.com/launchdarkly/observability-sdk/actions/workflows/browser.yml | ||
| [browser-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/session-replay.svg?style=flat-square | ||
| [browser-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/session-replay | ||
| [browser-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 | ||
| [browser-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/browser/docs/ | ||
| [browser-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/session-replay.svg?style=flat-square | ||
| [browser-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/session-replay.svg?style=flat-square |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| { | ||
| "name": "@launchdarkly/session-replay", | ||
| "version": "0.0.1", | ||
| "description": "Browser observability for your web app. Record session replays to visualize usage patterns.", | ||
| "keywords": [ | ||
| "launchdarkly", | ||
| "session replay", | ||
| "debugging", | ||
| "observability", | ||
| "browser", | ||
| "library" | ||
| ], | ||
| "homepage": "https://github.com/launchdarkly/observability-sdk#readme", | ||
| "bugs": { | ||
| "url": "https://github.com/launchdarkly/observability-sdk/issues", | ||
| "email": "[email protected]" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "repository": { | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/launchdarkly/observability-sdk.git" | ||
| } | ||
| }, | ||
| "type": "module", | ||
| "main": "./dist/index.js", | ||
| "module": "./dist/index.js", | ||
| "unpkg": "./dist/index.umd.js", | ||
| "jsdelivr": "./dist/index.umd.js", | ||
| "types": "./dist/index.d.ts", | ||
| "exports": { | ||
| "types": "./dist/index.d.ts", | ||
| "unpkg": "./dist/index.umd.js", | ||
| "jsdelivr": "./dist/index.umd.js", | ||
| "import": "./dist/index.js", | ||
| "require": "./dist/index.js", | ||
| "default": "./dist/index.js" | ||
| }, | ||
| "files": [ | ||
| "dist" | ||
| ], | ||
| "size-limit": [ | ||
| { | ||
| "path": [ | ||
| "dist/*.js", | ||
| "!dist/*.umd.js" | ||
| ], | ||
| "limit": "256 kB", | ||
| "brotli": true | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.