Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 6.52 KB

README.md

File metadata and controls

96 lines (61 loc) · 6.52 KB
Raw

OpenTelemetry Sandbox Web JS (opentelemetry-sandbox-web-js)

non-production level experimental Web JS packages

NPM Published Version Apache License

About this project

This repo is a sandbox for experimenting with Web JS optimizations and implementations for the OpenTelemetry JS project.

Any and ALL code in this repository SHOULD NOT BE USED FOR PRODUCTION as it is subject to change (over time) and will not be supported for production purposes. Any improvements identified by this sandbox will be either merged back to the official release repositories or if necessary new repo(s) may be created.

There will be NO Production level support for any code from this repository, if you are helping and experimenting with the SDK generated by this repo please feel free to create issues.

Official Repositories

For production level support please use these repositories

Sandbox Goals

  • Investigate creation of the Web-JS optimized Sdk (excluding generic node support, which is already supported by the official JS respository )

Current State / Support

  • Non-functional!

Branches

  • main Used to merge code from the auto-merge/repo-staging into a form that can be built while still containing the history and tags from the official repository's. This branch will also be updated periodically to merge the changes from the auto-merge/repo-staging so that working branches can consume changes from the original source repositories by rebasing to this branch.
  • [auto-merge/repo-staging] Used as a staging branch to merge the main branch from the original source OpenTelemetry JS; OpenTelemetry JS API repositories so that all commit history and tags are included in this repository. To avoid / reduce merge issues, as part of the auto-merge script it will ALWAYS select the source repository's version, this branch does not have any compile targets or validation. This branch will be updated periodically to continuously merge changes from the original master source repos into this repository.
  • minification (TBD) - used to experiment with different levels of minification.
  • release (TBD) Only if needed to publish packages for 3rd party testing.
  • auto-instrumentation-poc This branch is used to prototype new instrumentations that generate events (as log records).

Automated merge workflows

These scripts are designed to be run periodically to enable the continous merging of changes from the official repositories so that we don't end up creating and identifying changes that cannot be easily contributed back to the official repositories.

  • [Auto Merge] Merge official OTel JS repos to merge-staging
    • Used to merge all changes from the official repositories and their history into the auto-merge/repo-staging branch. This creates a PR to perform the merge and only 1 PR may exist at any point in time (running the workflow while a PR already exists will fail)
  • (TBD) [Auto Merge] Merge staging branch to main
    • This script (not in this initial PR) will be used to merge the files from the repo-staging branch into a structure that can be used and built. This will relocate the individual packages into a simplier stucture which will use rush and rollup to build and generate web bundles. And will also include web specific tests for all supported (merged) packages.

Contributing

When merging from the core repo's to main please use the automated script npm run merge-repos, this requires that you have cloned the source repos locally and assumes that they are located in the same root folder. See merge-source.js

We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and [good first issue][good-first-issues] to get started with the project. For instructions to build and make changes to this project, see the [CONTRIBUTING][CONTRIBUTING] guide.

We have a weekly SIG meeting! See the community page for meeting details and notes.

Approvers (@open-telemetry/... (TBD)):

...

Find more about the approver role in community repository.

Maintainers (@open-telemetry/js-maintainers):

Find more about the maintainer role in community repository.

Thanks to all the people who already contributed

Useful links

License

Apache 2.0 - See LICENSE for more information.