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.

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

docs: Fix compatibility issues with opentelemetry.io #953

Merged
merged 1 commit into from
Sep 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 5 additions & 12 deletions website_docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ weight: 24
description: >
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg"></img>
A language-specific implementation of OpenTelemetry in Ruby.
cascade:
github_repo: &repo https://github.com/open-telemetry/opentelemetry-ruby
github_subdir: website_docs
path_base_for_github_subdir: content/en/docs/ruby/
github_project_repo: *repo
---

This is the OpenTelemetry for Ruby documentation. OpenTelemetry is an observability framework -- an API, SDK, and tools that are designed to aid in the generation and collection of application telemetry data such as metrics, logs, and traces.
Expand All @@ -20,25 +25,13 @@ as follows:

The current release can be found [here][releases]

## Using OpenTelemetry Ruby

- [Quick Start][quick-start]
- [Context Propagation][context-propagation]
- [Span Events][events]
- [Manual Instrumentation][manual-instrumentation]

## Further Reading

- [OpenTelemetry for Ruby on GitHub][repository]
- [Ruby API Documentation][ruby-docs]
- [Examples][examples]

[quick-start]: quick_start.md
[repository]: https://github.com/open-telemetry/opentelemetry-ruby
[releases]: https://github.com/open-telemetry/opentelemetry-ruby/releases
[auto-instrumenation]: https://github.com/open-telemetry/opentelemetry-ruby#instrumentation-libraries
[context-propagation]: context_propagation.md
[events]: events.md
[manual-instrumentation]: manual_instrumentation.md
[ruby-docs]: https://open-telemetry.github.io/opentelemetry-ruby/
[examples]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples
9 changes: 2 additions & 7 deletions website_docs/context_propagation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: "Ruby Context Propagation"
weight: 24
description: >
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg"></img>
A language-specific implementation of OpenTelemetry in Ruby.
title: "Context Propagation"
weight: 2
---

## Context Propagation

> Distributed Tracing tracks the progression of a single Request, called a Trace, as it is handled by Services that make up an Application. A Distributed Trace transverses process, network and security boundaries. [glossary][glossary]

This requires _context propagation_, a mechanism where identifiers for a trace are sent to remote processes.
Expand Down
9 changes: 2 additions & 7 deletions website_docs/events.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: "Ruby Span Events"
weight: 24
description: >
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg"></img>
A language-specific implementation of OpenTelemetry in Ruby.
title: "Span Events"
weight: 3
---

## Events

An event is a human-readable message on a span that represents "something happening" during it's lifetime. For example, imagine a function that requires exclusive access to a resource that is under a mutex. An event could be created at two points - once, when we try to gain access to the resource, and another when we acquire the mutex.

```ruby
Expand Down
15 changes: 5 additions & 10 deletions website_docs/quick_start.md → website_docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: "Ruby Quick Start Guide"
weight: 24
description: >
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg"></img>
A language-specific implementation of OpenTelemetry in Ruby.
title: "Getting Started"
weight: 1
---

## Quick Start

[OpenTelemetry for Ruby][repository] can be used to add automatic and manual instrumentation to your applications.
Automatic instrumentation is enabled by adding [instrumentation packages][auto-instrumentation].
Manual instrumentation can be added using the [OpenTelemetry API][manual-instrumentation].
Expand Down Expand Up @@ -91,6 +86,6 @@ Adding tracing to a single service is a great first step and although auto-instr
[repository]: https://github.com/open-telemetry/opentelemetry-ruby
[auto-instrumentation]: https://github.com/open-telemetry/opentelemetry-ruby#instrumentation-libraries
[sdk-env]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options
[context-propagation]: context_propagation.md
[events]: events.md
[manual-instrumentation]: manual_instrumentation.md
[context-propagation]: ../context_propagation
[events]: ../events
[manual-instrumentation]: ../manual_instrumentation
9 changes: 2 additions & 7 deletions website_docs/manual_instrumentation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: "Ruby Manual Instrumentation"
weight: 24
description: >
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg"></img>
A language-specific implementation of OpenTelemetry in Ruby.
title: "Manual Instrumentation"
weight: 4
---

## Adding Manual Instrumentation

Auto-instrumentation is the easiest way to get started with instrumenting your code, but in order to get the most insight into your system, you should add manual instrumentation where appropriate.
To do this, use the OpenTelemetry SDK to access the currently executing span and add attributes to it, and/or to create new spans.

Expand Down