Install Observability on Mac/Linux¶

The dk-installer program installs DataOps Observability as a Docker Compose application. This is the recommended installation mode, as Docker encapsulates and isolates the application from other software on your machine and does not require you to manage Python dependencies.

Prerequisites¶

Install the following prerequisites, and verify that their versions are supported.

Software	Supported versions	Command to check version
Python 3 Most Linux and macOS systems have Python pre-installed. On Windows, you will need to download and install. Why Python? To run the installer.	3.9, 3.10, 3.11, 3.12, 3.13	`python3 --version`
Docker + Docker Compose Why Docker? Docker lets you try Observability without affecting your local software environment. All the dependencies Observability needs are isolated in its containers, so installation is easy and insulated.	Docker: 26.1, 27.5, 28.5 Compose: 2.38, 2.39, 2.40	`docker -v` `docker compose version`

How to install Observability¶

Create and navigate to a new directory for the installation, e.g., "/observability".

Download the latest version of dk-installer.

curl -o dk-installer.py 'https://raw.githubusercontent.com/DataKitchen/data-observability-installer/main/dk-installer.py'

Run the install command.
```
python3 dk-installer.py obs install
```
The installation downloads the latest Docker images for Observability and deploys a new Docker Compose application. The process may take 5~15 minutes, depending on your machine and network connection.

For advanced options, see the Installation Options section.
Verify that you can log in to the UI with the URL and credentials provided in the terminal output. You can also find this information at any time in the dk-obs-credentials.txt file.

How to setup demo data¶

You can also use the installer program to seed Observability with demo data for the Quick Start tutorial.

Verify that the UI is accessible and the obs-docker-compose.yml and demo-config.json files generated by the installation are present in the folder.
Run the demo setup command.
```
python3 dk-installer.py obs run-demo
```
In the Observability UI, you will see that new journeys and events have been generated.
Run the Agent Heartbeat demo setup command.
```
python3 dk-installer.py obs run-heartbeat-demo
```
In the Observability UI, you will see that new agents have been generated on the Integrations page.
Follow the Observability portions of the Quick Start demo tutorial for a walk-through of the software.

Tip

To upgrade an instance of Observability to the latest released version, see Upgrade Observability. For other post-install tasks, see Administer Observability.

Installation Options¶

--be-image and --ui-image: To install a specific version. The latest released version of Observability is installed by default. For a list of recent releases, see Observability Release Notes.
```
python3 dk-installer.py obs install \
  --be-image=datakitchen/dataops-observability-be:v<version> \
  --ui-image=datakitchen/dataops-observability-ui:v<version>
```
--port: To specify a custom port. The Observability application uses port 8082 by default.
```
python3 dk-installer.py obs install --port=<port>
```
--pull-timeout: To specify the maximum amount of time (in minutes) that Docker should be allowed to pull images. The installer uses a 5 minute timeout by default, and retries 3 times.
```
python3 dk-installer.py obs install --pull-timeout=<minutes>
```
--no-analytics: To disable sending anonymous analytics data to DataKitchen. For more details, see Anonymous Analytics.
```
python3 dk-installer.py --no-analytics obs install
```

How to remove demo data¶

After completing the quickstart, you can remove the demo data from Observability with the following steps.

Verify that the UI is accessible and the obs-docker-compose.yml and demo-config.json files generated by the installation are present in the folder.
Stop the process that is running the Agent Heartbeat demo using Ctrl + C. Note: Currently, the agents generated by the heartbeat demo are not cleaned up.

Run the delete demo command.

python3 dk-installer.py obs delete-demo