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 #392: Create a new entry in the TOC named Guides #397

Merged
merged 3 commits into from
Sep 10, 2024
Merged

Issue #392: Create a new entry in the TOC named Guides #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8264ad6
issue 392: Create a new entry in the TOC named Guides
iguitton Sep 10, 2024
eec2816
Issue #392: Create a new entry in the TOC named Guides
NassimBtk Sep 10, 2024
bebaa2b
Issue #392: Create a new entry in the TOC named Guides
NassimBtk Sep 10, 2024
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: 16 additions & 1 deletion metricshub-doc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,22 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.4.5</version>
<version>3.5.0</version>
<reportSets>
<reportSet>
<reports>
<report>ci-management</report>
<report>dependencies</report>
<report>dependency-info</report>
<report>distribution-management</report>
<report>issue-management</report>
<report>licenses</report>
<report>plugins</report>
<report>scm</report>
<report>summary</report>
</reports>
</reportSet>
</reportSets>
</plugin>

<!-- Generate reference through the MetricsHub Connector Maven Plugin -->
Expand Down
12 changes: 6 additions & 6 deletions metricshub-doc/src/site/markdown/configuration/configure-monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ resourceGroups:
<protocol-configuration>
```

> Note: Refer to the [sustainability metrics page](../sustainability/configure-sustainability-metrics.md#example-for-distributed-infrastructure) to configure MetricsHub for sustainability metrics reporting.
> Note: Refer to the [sustainability metrics page](../guides/configure-sustainability-metrics.md#example-for-distributed-infrastructure) to configure MetricsHub for sustainability metrics reporting.

### Centralized infrastructure

Expand All @@ -127,7 +127,7 @@ resources:
<protocol-configuration>
```

> Note: Refer to the [sustainability metrics page](../sustainability/configure-sustainability-metrics.md#example-for-centralized-infrastructure) to configure MetricsHub for sustainability metrics reporting.
> Note: Refer to the [sustainability metrics page](../guides/configure-sustainability-metrics.md#example-for-centralized-infrastructure) to configure MetricsHub for sustainability metrics reporting.

### Unique vs. shared characteristics

Expand Down Expand Up @@ -629,7 +629,7 @@ service-group:

#### Enterprise Edition authentication

In the Enterprise Edition, the **MetricsHub**'s internal `OTLP Exporter` authenticates itself with the _OpenTelemetry Collector_'s [OTLP gRPC Receiver](send-data.md#OTLP_gRPC) by including the HTTP `Authorization` request header with the credentials.
In the Enterprise Edition, the **MetricsHub**'s internal `OTLP Exporter` authenticates itself with the _OpenTelemetry Collector_'s [OTLP gRPC Receiver](send-telemetry.md#otlp-grpc) by including the HTTP `Authorization` request header with the credentials.

These settings are already configured in the `config/metricshub.yaml` file of **MetricsHub Enterprise Edition**. Changing them is **not recommended** unless you are familiar with managing communication between the **MetricsHub** `OTLP Exporter` and the _OpenTelemetry Collector_'s `OTLP Receiver`.

Expand All @@ -651,7 +651,7 @@ resourceGroups: # ...

where `<base64-username-password>` credentials are built by first joining your username and password with a colon (`myUsername:myPassword`) and then encoding the value in `base64`.

> **Warning**: If you update the *Basic Authentication Header*, you must generate a new `.htpasswd` file for the [OpenTelemetry Collector Basic Authenticator](send-data.md#Basic_Authenticator).
> **Warning**: If you update the *Basic Authentication Header*, you must generate a new `.htpasswd` file for the [OpenTelemetry Collector Basic Authenticator](send-telemetry.md#basic-authenticator).

#### Community Edition authentication

Expand Down Expand Up @@ -803,15 +803,15 @@ resourceGroups:

The core engine will perform automatic detection on connectors categorized under `hardware`, excluding the `MIB2` connector.

To know which connectors are available, refer to [Community Connector Platforms](../platform-requirements.html#!).
To know which connectors are available, refer to [Connectors Directory](../metricshub-connectors-directory.html).

Otherwise, you can list the available connectors using the below command:

```shell-session
$ metricshub -l
```

For more information about the `metricshub` command, refer to [MetricsHub CLI (metricshub)](../troubleshooting/cli.md).
For more information about the `metricshub` command, refer to [MetricsHub CLI (metricshub)](../guides/cli.md).

#### Patch Connectors

Expand Down
12 changes: 6 additions & 6 deletions metricshub-doc/src/site/markdown/configuration/send-telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ To configure the OpenTelemetry Collector of **MetricsHub Enterprise**, edit the
> **Warning**: Only update this section if you customized the [MetricsHub Agent settings](configure-monitoring.html#a-28optional-29-additional-settings).
The **MetricsHub Agent** pushes the collected data to the [`OTLP Receiver`](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver) via [gRPC](https://grpc.io/) on port **TCP/4317**.

The `OTLP Receiver` is configured by default with the self-signed certificate `security/otel.crt` and the private key `security/otel.key` to enable the TLS protocol. If you wish to set your own certificate file, configure the **MetricsHub Agent** with the correct [Trusted Certificates File](send-data.html#trusted-certificates-file). Because the `OTLP Exporter` of the **MetricsHub Agent** performs hostname verification, you will also have to add the `localhost` entry (`DNS:localhost,IP:127.0.0.1`) to the `Subject Alternative Name (SAN)` extension of the new generated certificate.
The `OTLP Receiver` is configured by default with the self-signed certificate `security/otel.crt` and the private key `security/otel.key` to enable the TLS protocol. If you wish to set your own certificate file, configure the **MetricsHub Agent** with the correct [Trusted Certificates File](send-telemetry.html#trusted-certificates-file). Because the `OTLP Exporter` of the **MetricsHub Agent** performs hostname verification, you will also have to add the `localhost` entry (`DNS:localhost,IP:127.0.0.1`) to the `Subject Alternative Name (SAN)` extension of the new generated certificate.

Clients requests are authenticated with the [Basic Authenticator extension](configure-monitoring.html#basic-authentication-header).
Clients requests are authenticated with the [Basic Authenticator extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/basicauthextension).

```yaml
otlp:
Expand Down Expand Up @@ -106,7 +106,7 @@ You can configure several exporters in the same instance of the *OpenTelemetry C

The [healthcheck](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/healthcheckextension) extension checks the status of **MetricsHub Enterprise** . It is activated by default and runs on port 13133 ([`http://localhost:13133`](http://localhost:13133)).

Refer to [Check the collector is up and running](../troubleshooting/status.html#Check_collector_is_up_and_running) for more details.
Refer to [Check the collector is up and running](../guides/status.html#check-the-collector-is-up-and-running) for more details.

#### zpages

Expand All @@ -116,7 +116,7 @@ The **zpages** extension provides debug information about all the different comp
* details about the active pipeline
* activity details of each receiver and exporter configured in the pipeline.

Refer to [Check the pipelines status](../troubleshooting/status.html#check-the-pipelines-status) for more details.
Refer to [Check the pipelines status](../guides/status.html#check-the-pipelines-status) for more details.

#### Basic Authenticator

Expand All @@ -131,7 +131,7 @@ Refer to the [Apache htpasswd](https://httpd.apache.org/docs/2.4/programs/htpass

The `.htpasswd` file is stored in the `security` directory.

> **Warning**: If a different password is specified in the `.htpasswd` file, update the [Basic Authentication Header](configure-monitoring.html#basic-authentication-header) of the **MetricsHub Agent**.
> **Warning**: If a different password is specified in the `.htpasswd` file, update the [Basic Authentication Header](configure-monitoring.html#enterprise-edition-authentication) of the **MetricsHub Agent**.

### The Pipeline

Expand Down Expand Up @@ -188,7 +188,7 @@ otel:
where `<prom-server-host>` should be replaced with the hostname or IP address of the server where *Prometheus* is running.

> **Note:**
> For specific configuration details, refer to the [OpenTelemetry Auto-Configure documentation](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure). This resource provides information about the properties to be configured depending on your deployment requirements.
> For specific configuration details, refer to the [OpenTelemetry Auto-Configure documentation](https://opentelemetry.io/docs/languages/java/configuration/). This resource provides information about the properties to be configured depending on your deployment requirements.

#### Trusted certificates file

Expand Down
Loading