Skip to content

Commit 3654a86

Browse files
Update main readme (open-telemetry#484)
Remove duplicated content from the main readme and add a link to the online documentation.
1 parent 52332ce commit 3654a86

File tree

2 files changed

+13
-62
lines changed

2 files changed

+13
-62
lines changed

README.md

Lines changed: 8 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -45,63 +45,11 @@ pip install -e ./opentelemetry-sdk
4545
pip install -e ./ext/opentelemetry-ext-{integration}
4646
```
4747

48-
## Quick Start
49-
50-
### Tracing
51-
52-
```python
53-
from opentelemetry import trace
54-
from opentelemetry.sdk.trace import TracerProvider
55-
from opentelemetry.sdk.trace.export import ConsoleSpanExporter
56-
from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor
57-
58-
trace.set_preferred_tracer_provider_implementation(lambda T: TracerProvider())
59-
trace.tracer_provider().add_span_processor(
60-
SimpleExportSpanProcessor(ConsoleSpanExporter())
61-
)
62-
tracer = trace.get_tracer(__name__)
63-
with tracer.start_as_current_span('foo'):
64-
with tracer.start_as_current_span('bar'):
65-
with tracer.start_as_current_span('baz'):
66-
print("Hello world from OpenTelemetry Python!")
67-
```
68-
69-
### Metrics
70-
71-
```python
72-
from opentelemetry import metrics
73-
from opentelemetry.sdk.metrics import Counter, MeterProvider
74-
from opentelemetry.sdk.metrics.export import ConsoleMetricsExporter
75-
from opentelemetry.sdk.metrics.export.controller import PushController
76-
77-
metrics.set_preferred_meter_provider_implementation(lambda _: MeterProvider())
78-
meter = metrics.get_meter(__name__)
79-
exporter = ConsoleMetricsExporter()
80-
controller = PushController(meter=meter, exporter=exporter, interval=5)
81-
82-
counter = meter.create_metric(
83-
name="available memory",
84-
description="available memory",
85-
unit="bytes",
86-
value_type=int,
87-
metric_type=Counter,
88-
label_keys=("environment",),
89-
)
90-
91-
label_set = meter.get_label_set({"environment": "staging"})
92-
bound_counter = counter.bind(label_set)
93-
bound_counter.add(100)
94-
```
95-
96-
See the [API documentation](https://open-telemetry.github.io/opentelemetry-python/) for more detail, and the [examples folder](./examples) for a more sample code.
97-
98-
## Extensions
99-
100-
### Third-party exporters
101-
102-
OpenTelemetry supports integration with the following third-party exporters.
48+
## Documentation
10349

104-
- [Azure Monitor](https://github.com/microsoft/opentelemetry-exporters-python/tree/master/azure_monitor)
50+
The online documentation is available at https://opentelemetry-python.readthedocs.io/,
51+
if you want to access the documentation for the latest version use
52+
https://opentelemetry-python.readthedocs.io/en/latest/.
10553

10654
## Contributing
10755

@@ -170,11 +118,12 @@ includes:
170118
- Flask Integration
171119
- PyMongo Integration
172120

173-
The v0.4 alpha release includes:
121+
The [v0.4 alpha
122+
release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.4.0) release includes:
174123

175124
- Metrics MinMaxSumCount Aggregator
176-
- Context API
177-
- Full Metrics SDK Pipeline
125+
- Context API
126+
- Full Metrics SDK Pipeline
178127
- Metrics STDOUT Exporter
179128
- Dbapi2 Integration
180129
- MySQL Integration

docs/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,19 @@ In addition, there are several extension packages which can be installed separat
3030

3131
The extension packages can be found in :scm_web:`ext/ directory of the repository <ext/>`.
3232

33-
In addition, third party exporters are available:
33+
Extensions
34+
----------
3435

35-
* `Azure Monitor <https://github.com/microsoft/opentelemetry-exporters-python/tree/master/azure_monitor>`_
36+
Visit `OpenTelemetry Registry <https://opentelemetry.io/registry/?s=python>`_ to find
37+
related projects like exporters, instrumentation libraries, tracer implementations, etc.
3638

3739
Installing Cutting Edge Packages
3840
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3941

4042
While the project is pre-1.0, there may be significant functionality that
4143
has not yet been released to PyPI. In that situation, you may want to
4244
install the packages directly from the repo. This can be done by cloning the
43-
repositry and doing an `editable
45+
repository and doing an `editable
4446
install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>`_:
4547

4648
.. code-block:: sh

0 commit comments

Comments
 (0)