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

Quick fixes #235

Merged
merged 2 commits into from
Sep 12, 2024
Merged

Quick fixes #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dc4ccb
Remove double quotes
calebschoepp Sep 11, 2024
3d8da19
Fix executor reference
calebschoepp Sep 11, 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
69 changes: 35 additions & 34 deletions content/en/docs/reference/spin-app-executor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ createDeployment is true.<br/>
<small>[back to parent](#spinappexecutorspec)</small>


DeploymentConfig specifies how the deployment should be configured when createDeployment is true.
DeploymentConfig specifies how the deployment should be configured when
createDeployment is true.

<table>
<thead>
Expand Down Expand Up @@ -136,10 +137,10 @@ defined in `CACertSecret` the secret name will be `spin-ca`.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>otel</b></td>
<td>string</td>
<td><b><a href="#spinappexecutorspecdeploymentconfigotel">otel</a></b></td>
<td>object</td>
<td>
Otel creates environment variables which configure where and how telemetry data is exported from the Spin app.
Otel provides Kubernetes Bindings to Otel Variables.<br/>
</td>
<td>false</td>
</tr></tbody>
Expand All @@ -149,7 +150,7 @@ defined in `CACertSecret` the secret name will be `spin-ca`.<br/>

<small>[back to parent](#spinappexecutorspecdeploymentconfig)</small>

Otel creates environment variables which configure where and how telemetry data is exported from the Spin app.
Otel provides Kubernetes Bindings to Otel Variables.

<table>
<thead>
Expand All @@ -161,32 +162,32 @@ Otel creates environment variables which configure where and how telemetry data
</tr>
</thead>
<tbody><tr>
<td><b>exporter_otlp_endpoint</b></td>
<td>string</td>
<td>
Defines an endpoint to where all metrics, log, and trace data are exported.
</td>
<td>false</td>
</tr><tr>
<td><b>exporter_otlp_traces_endpoint</b></td>
<td>string</td>
<td>
Defines an endpoint to where all trace data are exported.
</td>
<td>false</td>
</tr><tr>
<td><b>exporter_otlp_metrics_endpoint</b></td>
<td>string</td>
<td>
Defines an endpoint to where all metrics data are exported.
</td>
<td>false</td>
</tr><tr>
<td><b>exporter_otlp_logs_endpoint</b></td>
<td>string</td>
<td>
Defines an endpoint to where all log data are exported.
</td>
<td>false</td>
</tr>

<td><b>exporter_otlp_endpoint</b></td>
<td>string</td>
<td>
ExporterOtlpEndpoint configures the default combined otlp endpoint for sending telemetry<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>exporter_otlp_logs_endpoint</b></td>
<td>string</td>
<td>
ExporterOtlpLogsEndpoint configures the logs-specific otlp endpoint<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>exporter_otlp_metrics_endpoint</b></td>
<td>string</td>
<td>
ExporterOtlpMetricsEndpoint configures the metrics-specific otlp endpoint<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>exporter_otlp_traces_endpoint</b></td>
<td>string</td>
<td>
ExporterOtlpTracesEndpoint configures the trace-specific otlp endpoint<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
8 changes: 5 additions & 3 deletions content/en/docs/topics/monitoring-your-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,16 @@ Please ensure you have the following tools installed before continuing:
## About OpenTelemetry Collector

From the OpenTelemetry [documentation](https://opentelemetry.io/docs/collector/):
>> The OpenTelemetry Collector offers a vendor-agnostic implementation of how to receive, process and export telemetry data. It removes the need to run, operate, and maintain multiple agents/collectors. This works with improved scalability and supports open source observability data formats (e.g. Jaeger, Prometheus, Fluent Bit, etc.) sending to one or more open source or commercial backends.

> The OpenTelemetry Collector offers a vendor-agnostic implementation of how to receive, process and export telemetry data. It removes the need to run, operate, and maintain multiple agents/collectors. This works with improved scalability and supports open source observability data formats (e.g. Jaeger, Prometheus, Fluent Bit, etc.) sending to one or more open source or commercial backends.

In our case, the OpenTelemetry collector serves as a single endpoint to receive and route telemetry data, letting us to monitor metrics, traces, and logs via our preferred UIs.

## About Jaeger

From the Jaeger [documentation](https://www.jaegertracing.io/docs/):
>> Jaeger is a distributed tracing platform released as open source by Uber Technologies. With Jaeger you can: Monitor and troubleshoot distributed workflows, Identify performance bottlenecks, Track down root causes, Analyze service dependencies

> Jaeger is a distributed tracing platform released as open source by Uber Technologies. With Jaeger you can: Monitor and troubleshoot distributed workflows, Identify performance bottlenecks, Track down root causes, Analyze service dependencies

Here, we have the OpenTelemetry collector send the trace data to Jaeger.

Expand Down Expand Up @@ -150,4 +152,4 @@ To view the traces in Jaeger, use the following port-forward command:
kubectl port-forward svc/jaeger-query 16686:16686
```

Then, open your browser and navigate to `localhost:16686` to interact with Jaeger's UI.
Then, open your browser and navigate to `localhost:16686` to interact with Jaeger's UI.