spinkube / spin-operator

Spin Operator is a Kubernetes operator that empowers platform engineers to deploy Spin applications as custom resources to their Kubernetes clusters
https://www.spinkube.dev/docs/overview/
Other
185 stars 23 forks source link

Tutorial on how to set up observability solution for Spin Operator, runwasi, and Spin Apps #25

Closed calebschoepp closed 8 months ago

calebschoepp commented 9 months ago

This tutorial should give step by step guidance on how to set up observability solution (#110) so they can monitor installation of Spin Operator, Run Wasi, and their SpinApps (#108 ).

Prerequisites:

This content depends on implementation of #118 as well as any issue tied to #110 and #108 user stories

calebschoepp commented 9 months ago

CC @macolso @tpmccallum

macolso commented 8 months ago

@calebschoepp - if it's alright with you, I'm going to close this issue and open a new one in spinkube/documentation. Do you remember what sort of observability solution we had in mind here? I'm imagining the following:

Metrics Will likely be the doc compliment to #16 where we'd have two articles: architectural overview on how metrics work for SpinApps and Spin Operator; tutorial style on how to get started with one of our Grafana dashboard.

Logs Again, two articles: one focused on architectural overview (what types of logs are emitted today); one tutorial styled on how to connect to logging provider to export logs to desired observability solution (splunk, etc.)

Traces No story yet ???

What do you think?

calebschoepp commented 8 months ago

That all sounds reasonable to me and yes please feel free to move the issue.

macolso commented 8 months ago

Great! New doc issues include: