Skip to content

Commit

Permalink
shortened readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maeddes authored Oct 10, 2024
1 parent a86b9e2 commit 3e7dc9a
Showing 1 changed file with 1 addition and 74 deletions.
75 changes: 1 addition & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,3 @@
# Getting Started with OpenTelemetry
This repository offers a getting started guide for OpenTelemetry, the framework for vendor-neutral telemetry data collection.

## How to use this repo
The exercise lab resides in a single Git repository, which contains everything needed to run it across various environments.

The tutorial is a static website that explains key concepts and guides you through the practical exercises.
The hands-on exercises provide interactive experiences to help you grasp how to integrate OpenTelemetry into your applications.
It's worth noting that these exercises focus on teaching concepts rather than replicating real-world deployment scenarios.

The repository utilizes VS Code [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) to provide a consistent developer experience across platforms - local and remote.

<br /><br />
![Overview](tutorial/content/exercises/introduction/images/lab_tutorial_setup.png)

## Link to exercises

You can find the exercises/tutorial here: https://novatecconsulting.github.io/opentelemetry-training/

### Running the lab locally

This will be the default for running this lab. All exercises are described according to this way of using the lab.

To run the lab on your local machine, you'll need to have [Docker](https://docs.docker.com/engine/install/), [VS Code](https://code.visualstudio.com/download), and the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed.
When you open this repository with a locally installed VS Code instance, you'll see a prompt in the bottom right corner.
<br /><br />
![Prompt to open the repo inside a Dev container](tutorial/content/exercises/introduction/images/prompt.png)

Press `Reopen in Container` to allow VS Code to use the [devcontainer.json](.devcontainer/devcontainer.json) specification to set up the IDE. If you missed the prompt hit <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (on Mac <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) and type `Dev Containers: Rebuild and Reopen in Container`.

After that the [devcontainer spec](.devcontainer/devcontainer.json) will pull all needed dependencies to build and run the devcontainer in which we will work on the lab content. This can take a bit, so be patient.
<br /><br />
![Open the terminal](tutorial/content/exercises/introduction/images/open-terminal.png)

When you run an application that exposes a port, VS Code will notify you that it is accessible.
To open the application, just click `Open in Browser` or open your Browser manually and type the URL yourself.
<br /><br />
![Open the browser](tutorial/content/exercises/introduction/images/open-port.png)

When you missed the prompt you can see the open ports in the `PORTS` tab.
<br /><br />
![Where to find the forwarded ports](tutorial/content/exercises/introduction/images/ports.png)

### Running the lab remotely

To run the lab in a cloud-based development environment, you have two options: [GitHub Codespaces](https://codespaces.new/lftraining/LFS148-code) or [Gitpod](https://gitpod.io/#https://github.com/lftraining/LFS148-code).

To utilize either option, you'll need a personal GitHub account.
In both cases, a VSCode Instance in your browser will be opened automatically and you are immediately ready to go.

Normally Codespaces and Gitpod should work in an almost identical way as a local devcontainer setup. However these platforms are subject to change and we can't keep the lab tested continously on all remote platforms.
<br /><br />
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/lftraining/LFS148-code) [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/lftraining/LFS148-code)

### Differences between local and remote way of running the lab

Even though the experience with using a local or browser-based VS Code is fairly similar, one thing you need to take care of is the variation in hostnames and ports. In a local environment, you can use the combination of `localhost` and the corresponding port. In a remote environment, this will not work when trying to access endpoints via a browser.

This is the ports tab of a local VS Code environment:
<br /><br />
![VS Code ports](tutorial/content/exercises/introduction/images/vscode_ports.png)

This is the ports tab of a GitHub Codespaces environment:
<br /><br />
![Codespaces ports](tutorial/content/exercises/introduction/images/codespaces_ports.png)

This is the ports tab of a GitHub Codespaces environment:
<br /><br />
![Gitpod ports](tutorial/content/exercises/introduction/images/gitpod_ports.png)

You can see that they look almost identical. In some cases, you might have to hover over the address to reveal a link.

Another difference can be the root path in your terminal and file browser of VS Code.

# LFS148 - exercise repository


0 comments on commit 3e7dc9a

Please sign in to comment.