docs: add workspace process logging doc #9002
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matifali
reviewed
Aug 9, 2023
bpmct
approved these changes
Aug 14, 2023
Comment on lines
+64
to
+67
| We provide working example templates for Kubernetes, and Kubernetes with | ||
| `envbox` (for [Docker support in workspaces](./docker-in-workspaces.md)). You | ||
| can view these templates in the | ||
| [exectrace repo](https://github.com/coder/exectrace/tree/main/enterprise/templates). |
There was a problem hiding this comment.
Any ideas on how to avoid drift between these example templates and the code snippets in our docs? Perhaps we add a comment to both places informing users to update the other place?
There was a problem hiding this comment.
I added comments here and I'll add comments in the exectrace repo in a sec
docs/templates/process-logging.md
Outdated
Comment on lines
260
to
274
| ### View logs in AWS EKS | ||
|
|
||
| If you're using AWS' Elastic Kubernetes Service, you can [configure your | ||
| cluster][eks-cloudwatch] to send logs to CloudWatch. This allows you to view the | ||
| logs for a specific user or workspace. | ||
|
|
||
| To view your logs, go to the CloudWatch dashboard (which is available on the | ||
| **Log Insights** tab) and run a query similar to the following: | ||
|
|
||
| ```text | ||
| fields @timestamp, log_processed.fields.cmdline | ||
| | sort @timestamp asc | ||
| | filter kubernetes.container_name="exectrace" | ||
| | filter log_processed.fields.labels.username="zac" | ||
| | filter log_processed.fields.labels.workspace_name="code" |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Very similar to v1 but contains a section explaining how to add to existing templates.
Closes #8838