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

updating readme and badges #352

Merged
merged 1 commit into from
Dec 20, 2021
Merged
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
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px">

- [Observability](#observability)
- [Code Summary](#code-summary)
- [Plugin Components](#plugin-components)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Getting Help](#getting-help)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
- [Copyright](#copyright)

# Observability

The Observability plugin has four components: Trace Analytics, Event Analytics, Operational Panels, and Notebooks.
Observability is collection of plugins and applications that let you visualize data-driven events by using Piped Processing Language to explore, discover, and query data stored in OpenSearch.

## Code Summary

Expand Down Expand Up @@ -36,6 +49,8 @@ The Observability plugin has four components: Trace Analytics, Event Analytics,
| [![features open][feature-badge]][feature-link] |
| [![enhancements open][enhancement-badge]][enhancement-link] |
| [![bugs open][bug-badge]][bug-link] |
| [![untriaged open][untriaged-badge]][untriaged-link] |
| [![nolabel open][nolabel-badge]][nolabel-link] |

[dco-badge]: https://github.com/opensearch-project/observability/actions/workflows/dco.yml/badge.svg
[dco-badge-link]: https://github.com/opensearch-project/observability/actions/workflows/dco.yml
Expand Down Expand Up @@ -66,6 +81,14 @@ The Observability plugin has four components: Trace Analytics, Event Analytics,
[bug-link]: https://github.com/opensearch-project/observability/issues?q=is%3Aopen+is%3Aissue+label%3Abug+
[enhancement-badge]: https://img.shields.io/github/issues/opensearch-project/observability/enhancement.svg
[enhancement-link]: https://github.com/opensearch-project/observability/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+
[untriaged-badge]: https://img.shields.io/github/issues/opensearch-project/observability/untriaged.svg
[untriaged-link]: https://github.com/opensearch-project/observability/issues?q=is%3Aopen+is%3Aissue+label%3Auntriaged+
[nolabel-badge]: https://img.shields.io/github/issues-search/opensearch-project/observability?color=yellow&label=no%20label%20issues&query=is%3Aopen%20is%3Aissue%20no%3Alabel
[nolabel-link]: https://github.com/opensearch-project/observability/issues?q=is%3Aopen+is%3Aissue+no%3Alabel+

## Plugin Components

The Observability plugin has four components: Trace Analytics, Event Analytics, Operational Panels, and Notebooks.

### Trace Analytics

Expand Down