Create documentation for running the OTel Demo on GitHub Codespaces

[avillela]

I think that it would be helpful to the community to have documentation on running the OTel Demo using GitHub Codespaces. We can do it in one of two ways:

1. Blog post
2. Add it to the docs

Thoughts??

[svrnm]

thanks @avillela, as you know I always prefer more docs over having blog posts;-) but in that particular case I wonder more about GH codespaces being a commercial solution how well that goes with our social media guide. I might be overly paranoid here, especially sing codespaces is not an o11y product, but I wanted to call that out.

I would enjoy reading such a blog post (or docs page), but I am conflicted on that.

@open-telemetry/demo-approvers @open-telemetry/docs-approvers, wdyt?

[puckpuck]

I'm not even sure it works, but getting the otel-demo to work in a dev container environment and using GitHub Codespaces as an example in a blog post would be okay.

[avillela]

I'm not even sure it works, but getting the otel-demo to work in a dev container environment and using GitHub Codespaces as an example in a blog post would be okay.

I did get it running a few weeks back in GH Codespaces - had to beef up the container specs to get it to work and get the various UIs to run 😁

[julianocosta89]

I'd be okay with it, but as @svrnm mentioned, I believe we should try to keep it as agnostic as possible.
@avillela is there much config difference in running locally with devcontainer and GH Codespaces?

Mastodon project has the .devcontainer definition in its repo and when you open the project, you get a pop up asking if you'd like to open it in codespaces or locally.

The blog/doc could focus on running the demo locally, and if people want to run in Codespaces, they could use the same config, but we as community do not "advertise" it. WDYT?

[puckpuck]

+1 to getting a proper .devcontainer definition in the Otel demo so it can work in that world.

[svrnm]

Not an expert on the matter, but if there is an OSS solution under codespaces we could support officially that would be my favourite solution.

[avillela]

I definitely like the idea @julianocosta89. I can explore a pure devcontainer solution a bit further. Stay tuned!

[avillela]

Okay...I created a devcontainer that seems to work (tested it a bunch of times). Check it out here. Before I submit a PR, let me know if you think this is worthwhile, @julianocosta89.

[julianocosta89]

@avillela I've tried it on my M1 and got the following error:

Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: waiting for init preliminary setup: read init-p: connection reset by peer: unknown

Have you faced something similar?

[avillela]

@avillela I've tried it on my M1 and got the following error:

Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: waiting for init preliminary setup: read init-p: connection reset by peer: unknown

Have you faced something similar?

@julianocosta89 Do you get this error when starting up the devcontainer locally?

The issue I've had is that ARM images aren't supported by devcontainers, so the workaround is to first pull the amd64 version of the base image manually before trying to run the devcontainer:

docker pull --platform linux/amd64 mcr.microsoft.com/devcontainers/base:ubuntu

I've tested this successfully in:

• GH Codespaces (remote)
• Dev Containers VSCode plugin (local)
• DevPod using the Docker provider and VSCode (local)

Also, I had to tweak the devcontainer.json because it wasn't running properly locally, so you'll need to pull the latest code.

[julianocosta89]

@avillela awesome!
I think the ghcr.io/devcontainers/features/docker-in-docker:2 was the missing piece ⭐

It works great!

QQ as we are at it, do we want to focus on the devcontainer just to run the demo, or could we also add the programming languages dependencies and use it to modify the services as well?
With that we could use the guide as a contributing guide too, WDYT?

[julianocosta89]

Doing some tests, I've just noticed that OpenSearch doesn't start 😢

Disabling OpenSearch Security Plugin
Enabling execution of OPENSEARCH_HOME/bin/opensearch-performance-analyzer/performance-analyzer-agent-cli for OpenSearch Performance Analyzer Plugin
WARNING: Using incubator modules: jdk.incubator.vector
WARNING: A terminally deprecated method in java.lang.System has been called
WARNING: System::setSecurityManager has been called by org.opensearch.bootstrap.OpenSearch (file:/usr/share/opensearch/lib/opensearch-2.14.0.jar)
WARNING: Please consider reporting this to the maintainers of org.opensearch.bootstrap.OpenSearch
WARNING: System::setSecurityManager will be removed in a future release
Jul 18, 2024 6:41:39 AM sun.util.locale.provider.LocaleProviderAdapter <clinit>
WARNING: COMPAT locale provider will be removed in a future release
[2024-07-18T06:41:40,178][WARN ][o.o.b.JNANatives         ] [demo-node] unable to install syscall filter: 
java.lang.UnsupportedOperationException: seccomp unavailable: CONFIG_SECCOMP not compiled into kernel, CONFIG_SECCOMP and CONFIG_SECCOMP_FILTER are needed
        at org.opensearch.bootstrap.SystemCallFilter.linuxImpl(SystemCallFilter.java:375) ~[opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.SystemCallFilter.init(SystemCallFilter.java:666) ~[opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.JNANatives.tryInstallSystemCallFilter(JNANatives.java:281) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.Natives.tryInstallSystemCallFilter(Natives.java:128) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.Bootstrap.initializeNatives(Bootstrap.java:129) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.Bootstrap.setup(Bootstrap.java:191) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.Bootstrap.init(Bootstrap.java:404) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.OpenSearch.init(OpenSearch.java:181) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.OpenSearch.execute(OpenSearch.java:172) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.cli.EnvironmentAwareCommand.execute(EnvironmentAwareCommand.java:104) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.cli.Command.mainWithoutErrorHandling(Command.java:138) [opensearch-cli-2.14.0.jar:2.14.0]
        at org.opensearch.cli.Command.main(Command.java:101) [opensearch-cli-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.OpenSearch.main(OpenSearch.java:138) [opensearch-2.14.0.jar:2.14.0]
        at org.opensearch.bootstrap.OpenSearch.main(OpenSearch.java:104) [opensearch-2.14.0.jar:2.14.0]
./opensearch-docker-entrypoint.sh: line 69:    30 Killed                  "$@" "${opensearch_opts[@]}"

As it doesn't start, we do not get logs in Grafana.

[avillela]

Interesting. Have you tried re-strating services (docker compose down followed by docker compose up)? For example, I find sometimes that the Grafana UI doesn't load up initially, and I have to re-start and then it works. I suspect that the same thing may happen for OpenSearch. I only mention this because I just did a test both via local Dev Container and in GH Codespaces and logs are showing for me. Attaching screen shots of logs showing in Grafana.

GitHub Codespaces

Local Dev Container