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

Add opentelemetry.io docs #691

Merged
merged 2 commits into from
Apr 30, 2021
Merged
Changes from 1 commit
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
32 changes: 32 additions & 0 deletions website_docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Ruby"
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.
---

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. This documentation is designed to help you understand how to
get started using OpenTelemetry for Ruby.

## Status and Releases

The current status of the major functional components for OpenTelemetry Ruby is
as follows:

| Tracing | Metrics | Logging |
| ------- | ------- | ------- |
| Beta | Alpha | Not Yet Implemented |
fbogsany marked this conversation as resolved.
Show resolved Hide resolved

The current release can be found [here](https://github.com/open-telemetry/opentelemetry-ruby/releases)

## Further Reading

- [OpenTelemetry for Ruby on GitHub](https://github.com/open-telemetry/opentelemetry-ruby)
- [Installation](https://github.com/open-telemetry/opentelemetry-ruby#installation)
- [Quick Start](https://github.com/open-telemetry/opentelemetry-ruby#quick-start)
- [API Documentation](https://open-telemetry.github.io/opentelemetry-ruby/)
- [Examples](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples)