Skip to content

Commit

Permalink
Merge branch 'main' of github.com:baselime/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
boristane committed Apr 13, 2024
2 parents c264be5 + 8efee31 commit ac22495
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 11 deletions.
14 changes: 14 additions & 0 deletions sending-data/platforms/aws/aws-lambda/traces/node.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@ For detailed instructions on how to add the tag to for your framework go to the

---

## Configuration

Our OpenTelemetry SDK can be configured with the following environment variables. For each value other than log level set it to 'true' to turn the feature on.

| Environment Variable | Description | Default Value |
|----------------------------|--------------------------------------------------------|---------------|
| BASELIME_REQUEST_CAPTURE | Controls capturing of incoming requests | Not set |
| AWS_SDK_INTERNALS | Controls whether AWS SDK internals are logged | Not set |
| BASELIME_CAPTURE_EVENT | Controls capturing of specific events | Not set |
| BASELIME_CAPTURE_RESPONSE | Controls capturing of outgoing responses | Not set |
| OTEL_LOG_LEVEL | Sets the logging level for OpenTelemetry instrumentation. Set to "debug" to see granular diagnostics | Not set |



## Adding custom OpenTelemetry spans

To add custom spans to your OpenTelemetry traces, install the `@opentelemetry/api` package.
Expand Down
14 changes: 9 additions & 5 deletions sending-data/platforms/aws/ecs-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,13 @@ export function API({ stack }: StackContext) {
logging: new ecs.FireLensLogDriver({
options: {
"Name": "http",
"Host": "ecs-logs-ingest.baselime.io",
"Host": "events.baselime.io",
"Port": "443",
"TLS": "on",
"format": "json",
"retry_limit": "2",
"header": `x-api-key ${key}`,
"URI": "/v1/ecs-logs"
},
}),
}
Expand All @@ -99,12 +100,13 @@ resource "aws_ecs_task_definition" "example_task" {
log_driver = "awsfirelens"
options = {
"Name" = "http"
"Host" = "ecs-logs-ingest.baselime.io"
"Host" = "events.baselime.io"
"Port" = "443"
"TLS" = "on"
"format" = "json"
"retry_limit" = "2"
"header" = "x-api-key <BASELIME_API_KEY>"
"URI" = "/v1/ecs-logs"
}
}
}
Expand All @@ -126,12 +128,13 @@ taskDef.addContainer("container", {
logging: new ecs.FireLensLogDriver({
options: {
"Name": "http",
"Host": "ecs-logs-ingest.baselime.io",
"Host": "events.baselime.io",
"Port": "443",
"TLS": "on",
"format": "json",
"retry_limit": "2",
"header": `x-api-key <BASELIME_API_KEY>`,
"URI": "/v1/ecs-logs"
},
}),
});
Expand All @@ -153,13 +156,14 @@ taskDef.addContainer("container", {
"logConfiguration": {
"logDriver": "awsfirelens",
"options": {
"Host": "ecs-logs-ingest.baselime.io",
"Host": "events.baselime.io",
"Name": "http",
"Port": "443",
"TLS": "on",
"format": "json",
"header": "x-api-key <BASELIME_API_KEY>",
"retry_limit": "2"
"retry_limit": "2",
"URI": "/v1/ecs-logs"
},
"secretOptions": []
}
Expand Down
4 changes: 2 additions & 2 deletions sending-data/platforms/cloudflare/logpush.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Use the API Token you created in the previous step to connect your Cloudflare ac

### 3. Enable Logpush on Your Cloudflare Workers

To complete the setup, it's necessary to enable Logpush on your Cloudflare workers.
To complete the setup, it's necessary to enable Logpush on your Cloudflare Workers.

Add `logpush = true` to the top level section of your Workers `wrangler.toml` file

Expand All @@ -71,7 +71,7 @@ route = { pattern = "example.org/*", zone_name = "example.org" }
```

!!!
Learn more about [enabling Logpush on your Cloudflare workers](https://developers.cloudflare.com/workers/observability/logpush/#enable-logging-on-your-worker).
Learn more about [enabling Logpush on your Cloudflare Workers](https://developers.cloudflare.com/workers/observability/logpush/#enable-logging-on-your-worker).
!!!

### 4. Using the Cloudflare Workers Logpush integration
Expand Down
2 changes: 1 addition & 1 deletion sending-data/platforms/cloudflare/traces.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Get your pulic BASELIME_API_KEY from the [Baselime console](https://console.base
SERVICE_NAME = "my-service-name"
```

Once these steps are completed, distributed traces from your Cloudflare workers application should be available in Baselime to query via the console or the Baselime CLI.
Once these steps are completed, distributed traces from your Cloudflare Workers application should be available in Baselime to query via the console or the Baselime CLI.

![Example Cloudflare Worker Trace](../../../assets/images/illustrations/sending-data/opentelemetry/cf-tracing.png)

Expand Down
4 changes: 2 additions & 2 deletions sending-data/platforms/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Obtain your API key from the console [Baselime console](https://console.baselime
Next install the Baselime Helm chart
```bash
helm repo add baselime-logs-exporter https://github.com/baselime/helm-charts
helm repo add baselime-logs-exporter https://baselime.github.io/helm-charts
helm repo update
helm install baselime-logs-exporter baselime-logs-exporter/baselime-logs-exporter-logs-exporter --values custom-values.yaml
helm install baselime-logs-exporter baselime-logs-exporter/baselime-logs-exporter --values custom-values.yaml
```

---
Expand Down
2 changes: 1 addition & 1 deletion tux/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: -1

---

Tux is an AI assistant that resolves errors and performance issues in your applications. Tux understands your architecture by leveraging the powers of Baselime to gather context from your telemtry data, and enables you to resolve issues before they become problems.
Tux is an AI assistant that resolves errors and performance issues in your applications. Tux understands your architecture by leveraging the powers of Baselime to gather context from your telemetry data, and enables you to resolve issues before they become problems.

[!embed](https://www.youtube.com/watch?v=gcF1XW8aIuQ)

Expand Down

0 comments on commit ac22495

Please sign in to comment.