This sandbox serves a fortune telling web application based on Zoltar Speaks from the timeless Tom Hanks film Big. Thus we have ZoltBits Speaks who will tell all of your Datadog fortunes! And by "fortunes" I mean small pieces of info related to either Logs, Agent, or Synthetics that I have scraped from our docs.
The front end is built with Angular and is served using an Angular development server, the back end is a simple Express (NodeJS) server, and the database being used is MySQL. I have used a docker-compose file to define and run the application containers.
The Express and Angular services are built from a Dockerfile that you can see within the service's directory (i.e. fortune-teller-express/Dockerfile). The MySQL service is built directly from the mysql:8.0.20 image, then the database is initialized from a startup SQL script fortune-teller/fortune-teller-mysql/mysql-db-init-files/fortune-teller-mysql-script.sql. The Datadog Agent service is built directly from the latest Agent image (datadog/agent:latest) with all necessary initialization settings provided directly in the docker-compose file via environment variables.
Once the application is spun up, you be able to see the related logs, traces, and RUM data being sent to your Datadog account. For traces you will notice we are getting the full stack trace by connecting RUM and Traces. You can also install the MySQL integration in your account, as the agent will autodiscover the MySQL database through the container labels.
GET /getFortune/Synthetics- https://a.cl.ly/YEuOGzvKGET /getError/500- https://a.cl.ly/jku4g6nR
Prerequisites: You must have Docker installed to your machine- you can verify this by running docker --version. If you need to install Docker, you can do so by following this link. Then, clone this repository or download the fortune-teller folder to your machine
- Step 1: Create a RUM Application in your Datadog account
- Step 2: Configure ENV file with your Datadog Agent API key, Datadog RUM App ID, and Datadog RUM Client Token
- Step 3: Spin up the Docker containers
- Step 4: Generate some of that sweet sweet data
- Step 5: View the data in your Datadog account
- Step 6: Shut it down!
- Credits
- Docker tips to manage your local memory
Create a new application in your Datadog account by following this link, name the application fortune-teller and select Generate Client Token. The init block will contain your clientToken and applicationId. Copy these two strings and keep them handy, as you will need them for Step 2.
Step 2. Configure ENV file with your Datadog Agent API key, Datadog RUM App ID, and Datadog RUM Client Token
In your ~ directory, create a file called sandbox.docker.env that contains:
DD_API_KEY=<YOUR_API_KEY>
DD_FT_APP_ID=<YOUR_APP_ID>
DD_FT_CLIENT_TOKEN=<YOUR_CLIENT_TOKEN>
- Build the images using the following command:
docker-compose build. Note: This may take awhile if it is your first time runningfortune-teller. - Spin up the containers using the following command:
docker-compose up
Verify the app has been fully initialized by running docker ps -a. You should see all four fortune-teller containers (fortune-teller_angular_web_1, datadog-agent-ft, fortune-teller_express_server_1, fortune-teller_mysql_db_1) as Up. It may take several minutes for the server to stand up. You can check the logs (Logs Search) to gain some deeper insights if you suspect something has gone wrong. You can then navigate to localhost:4200 on your favorite web browser and start interacting with fortune-teller. Click on the topic buttons on the top toolbar of the screen to receive a fortune, or click the error codes to generate an error:
https://a.cl.ly/X6ulkdjb
Go to your Logs Search view to see the app-generated logs in your Datadog account. Check out the live traces coming in as you interact with the page, and view your RUM data by clicking into the fortune-teller application from your RUM Applications page.
If you are still in the same terminal you have initialized the app from, you can use Ctrl + C to stop the containers, then run docker-compose down to remove the containers and the network. If you are in a different terminal, you can simply run docker-compose down to both stop the application and remove the containers/network.
A lot of the logging and Node APM configuration I sourced from Wan's Node APM 101 Sessions as well as her docker-express-pg sandbox. My desire to incorporate the RUM aspects and build out a front end came from Zach's reactdog sandbox. Thanks Wan and Zach!
Some commands to clear out unsused image layers, containers and volumes from your local machine:
docker rm $(docker ps -f status=exited -aq)
docker rmi $(docker images -f "dangling=true" -q)
docker volume rm $(docker volume ls -qf dangling=true)