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.

Sign up for GitHub

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

Jump to bottom

Issue #92: Documented general concepts #99

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Issue #92: Documented general concepts #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 9 additions & 8 deletions metricshub-doc/src/site/markdown/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,35 @@ description: Concepts.

# General Concepts

## Attributes
<!--Previously called extraMetrics-->

## Connectors

Connectors are yaml files which describe how to collect metrics about a specific resource (a host, an application, a service, etc.). There are two types of connectors:

* The **Community Connectors** which are open-source and bring basic monitoring coverage,
* The **Enterprise Connectors** which are a proprietary library of connectors developed by [Sentry Software](https://sentrysoftware.com) which offers extended hardware monitoring.

Anyone is encouraged to create their own connectors and share them with the community.

## Connectors Variables
Anyone is encouraged to create their own connectors and share them with the [community](https://github.com/sentrysoftware/metricshub).

## Metrics

Telemetry data collected by **MetricsHub** which provide valuable information about the monitored resource.

## Monitors

Custom connector, set in `metricshub.yaml`, which defines how to collect metrics about a specific resource. A monitor defines a job which executes sources, computes, and collects metrics.

## OTLP

OTLP is the OpenTelemetry protocol used to exchange data between **MetricsHub** and an observability back-end.

## OTLP Receiver

An OTLP receiver acts as an entry point for metrics into an observability back-end or OpenTelemetry Collector.

## Resource Group

Resource group helps organize and manage assets in a structured manner.
Resource group helps organize and manage the monitored resources in a structured manner.

## Resource

Generic term to cover anything monitored by **MetricsHub**. A resource can be a host, a service, an application, etc.
Generic term to cover anything monitored by **MetricsHub**. A resource can be a host, a service, an application, etc.
21 changes: 0 additions & 21 deletions metricshub-doc/src/site/markdown/glossary.md
View file
Open in desktop

This file was deleted.

6 changes: 1 addition & 5 deletions metricshub-doc/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<menu name="Getting Started">
<item name="Overview" href="index.html" />
<item name="Quick Start" href="start.html "/>
<item name="General Concepts" href="concepts.html "/>
<item name="Installation" href="install.html" />
</menu>

Expand Down Expand Up @@ -119,11 +120,6 @@
<item name="Connector Object References" href="connector-design-guide/connector-object-references.html" />
</menu>

<!--
<menu name="Use Cases">
<item name="Custom Monitoring" href="usecases/custom.html" />
</menu>-->

<menu name="Appendix">
<item name="Community Connectors Reference" href="metricshub-connector-reference.html" />
<item name="Community Connector Platforms" href="platform-requirements.html" />
Expand Down