Skip to content

Commit

Permalink
Re-add CODEOWNERS and docs (#16)
Browse files Browse the repository at this point in the history
* Re-add CODEOWNERS and docs

After mirror of OC Service repo, re-add new files to get back to
consistent state.

* Remove .github directory
  • Loading branch information
flands authored and bogdandrutu committed Jun 18, 2019
1 parent 9317ffe commit f8bd7cf
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 15 deletions.
6 changes: 0 additions & 6 deletions .github/CODEOWNERS

This file was deleted.

9 changes: 0 additions & 9 deletions .github/wip.yml

This file was deleted.

15 changes: 15 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#####################################################
#
# List of approvers for OpenTelemetry Service
#
#####################################################
#
# Learn about membership in OpenTelemetry community:
# https://github.com/open-telemetry/community/blob/master/community-membership.md
#
#
# Learn about CODEOWNERS file format:
# https://help.github.com/en/articles/about-code-owners
#

* @bogdandrutu @pjanotti @flands @songy23 @tigrannajaryan
23 changes: 23 additions & 0 deletions docs/VISION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenTelemetry Service Long-term Vision

The following are high-level items that define our long-term vision for OpenTelemetry Service, what we aspire to achieve. This vision is our daily guidance when we design new features and make changes to the Service.

This is a living document that is expected to evolve over time.

## Performant
Highly stable and performant under varying loads. Well-behaved under extreme load, with predictable, low resource consumption.

## Observable
Expose own operational metrics in a clear way. Be an exemplar of observable service. Allow configuring the level of observability (more or less metrics, traces, logs, etc reported).

## Multi-Data
Support traces, metrics, logs and other relevant data types.

## Usable Out of the Box
Reasonable default configuration, supports popular protocols, runs and collects out of the box.

## Extensible
Extensible and customizable without touching the core code. Can create custom agents based on the core and extend with own components. Welcoming 3rd party contribution policy.

## Unified Codebase
One codebase for daemon (Agent) and standalone service (Collector).
47 changes: 47 additions & 0 deletions docs/migrating-from-opencensus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Action Plan for Bootstraping from OpenCensus

### Goals
We need to bootstrap the OpenTelemetry Service using the existing OpenCensus Service codebase. We agreed to split the Service codebase into 2 parts: core and contrib. This bootstrapping is a good opportunity to do the splitting by only including in the OpenTelemetry Service core the minimum number of receivers and exporters and moving the rest of functionality to a contrib package (most vendor-specific code).

The contrib package and vendor-specific receivers and exporters will continue to be available and there is no intent to retire it. The intent is to have a clear decoupling in the codebase that facilitates independent contribution of new components in the future, allows to easily create customized versions of a Service and makes it clear that core contributors will be responsible for maintenance of the core while vendor-specific components will be maintained by corresponding vendors (note: this does not exclude dual participation at all - some developers will likely work for vendors and will also be core maintainers).

# Migration Tasks

This is the action plan that also shows the progress. Tick the boxes after the task is complete.

[ ] Copy all commits from https://github.com/census-instrumentation/opencensus-service to https://github.com/open-telemetry/opentelemetry-service
Make sure commit history is preserved.

[ ] Remove receivers and exporters that are not part of core. We will keep the following in the core:

- Prometheus
- Jaeger (agent and collector ones)
- Zipkin
- OpenCensus, temporarily until OpenTelemetry one is available (we may want to keep OC for longer to facilitate migrations)

[ ] Cleanly decouple `core` from `cmd` in the repository. `core` will contain all business logic. `cmd` will be just a main.go that executes the business logic and compiles to `otsvc` executable.

`otsvc` will will only include receivers and exporters which we consider to be part of the core.

The new codebase will contain improvements which are already in progress and which are aimed at making the codebase extensible and enable the splitting to core and contrib. This includes 3 initiatives:

- Decoupling of receiver and exporter implementations from the core logic.

- Introduction of receiver and exporter factories that can be individually registered to activate them.

- Implementation of the [new configuration format](https://docs.google.com/document/d/1GWOzV0H0RTN1adiwo7fTmkjfCATDDFGuOB4jp3ldCc8/edit#) that makes use of factories and allows for greater flexibility in the configuration.

The functionally of the new `otsvc` will heavily lean on existing implementation and will be mostly a superset of the current agent/collector functionality when considering core receivers and exporters only (however we will allow deviations if it saves significant implementation effort and makes the service better).

[ ] Provide guidelines and example implementations for vendors to follow when they add new receivers and exporters to the contrib package.

[ ] Create a new repository for contrib and copy all commits from https://github.com/census-instrumentation/opencensus-service to https://github.com/open-telemetry/opentelemetry-service
Make sure commit history is preserved.

[ ] Cleanup the `contrib` repo to only contain additional vendor specific receivers and exporters.

(Note: alternatively `contrib` can be a directory in the main repo - this is still open for discussion).

[ ] Provide OpenCensus-to-OpenTelemetry Service migration guidelines for end-users who want to migrate. This will include recommendations on configuration file migration. We will also consider the possibility to support old configuration format in the new binary.

This approach allows us to have significant progress towards 2 stated goals in our [vision document](../blob/master/docs/VISION.md): unify the codebase for agent and collector and make the service more extensible.

0 comments on commit f8bd7cf

Please sign in to comment.