# Tracker Stores

All conversations are stored within a tracker store. Rasa Open Source provides implementations for different store types out of the box. If you want to use another store, you can also build a custom tracker store by extending the `TrackerStore` class.

## Contents

- [Tracker Stores](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#tracker-stores)
  - [InMemoryTrackerStore (default)](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#inmemorytrackerstore-default)
  - [SQLTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#sqltrackerstore)
  - [RedisTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#redistrackerstore)
  - [MongoTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#mongotrackerstore)
  - [DynamoTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#dynamotrackerstore)
  - [Custom Tracker Store](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#custom-tracker-store)

## [InMemoryTrackerStore (default)](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#id4)

Description

`InMemoryTrackerStore` is the default tracker store. It is used if no other tracker store is configured. It stores the conversation history in memory.

> **Note**: As this store keeps all history in memory, the entire history is lost if you restart the Rasa server.

Configuration

To use the `InMemoryTrackerStore` no configuration is needed.

## [SQLTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#id5)

Description

`SQLTrackerStore` can be used to store the conversation history in an SQL database. Storing your trackers this way allows you to query the event database by sender_id, timestamp, action name, intent name and typename.

Configuration

To set up Rasa Open Source with SQL the following steps are required:

1. Add required configuration to your `endpoints.yml`:
   
```yaml
tracker_store:
    type: SQL
    dialect: "postgresql"
    url: ""
    db: "rasa"
    username: 
    password: 
    query: 
      driver: my-driver
```

2. To start the Rasa server using your SQL backend, add the `--endpoints` flag:

```shell
rasa run -m models --endpoints endpoints.yml
```

3. If deploying your model in Docker Compose, add the service to your `docker-compose.yml`:

```yaml
postgres:
  image: postgres:latest
```

Parameters

- `domain` (default: `None`): Domain object associated with this tracker store
- `dialect` (default: `sqlite`): The dialect used to communicate with your SQL backend.
- `url`: URL of your SQL server
- `port`: Port of your SQL server
- `db`: The path to the database to be used
- `username`: The username used for authentication
- `password`: The password used for authentication
- `event_broker`: Event broker to publish events to
- `query`: Dictionary of options to be passed to the dialect and/or the DBAPI upon connect

Officially Compatible Databases

- PostgreSQL
- Oracle > 11.0
- SQLite

## [RedisTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#id6)

Description

`RedisTrackerStore` can be used to store the conversation history in [Redis](https://redis.io/). Redis is a fast in-memory key-value store which can optionally also persist data.

Configuration

To set up Rasa Open Source with Redis the following steps are required:

1. Start your Redis instance

2. Add required configuration to your `endpoints.yml`:

```yaml
tracker_store:
    type: redis
    url: <url of the redis instance, e.g. localhost>
    port: <port of your redis instance, usually 6379>
    db: <number of your database within redis, e.g. 0>
    password: <password used for authentication>
    use_ssl: <whether or not the communication is encrypted, default `false`>
```

## [MongoTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#id7)

Description

`MongoTrackerStore` can be used to store the conversation history in [Mongo](https://www.mongodb.com/). MongoDB is a free and open-source cross-platform document-oriented NoSQL database.

Configuration

1. Start your MongoDB instance.
2. Add required configuration to your `endpoints.yml`:

```yaml
tracker_store:
    type: mongod
    url: <url to your mongo instance, e.g. mongodb://localhost:27017>
    db: <name of the db within your mongo instance, e.g. rasa>
    username: <username used for authentication>
    password: <password used for authentication>
    auth_source: <database name associated with the user’s credentials>
```

## [DynamoTrackerStore](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#id8)

Description

`DynamoTrackerStore` can be used to store the conversation history in [DynamoDB](https://aws.amazon.com/dynamodb/). DynamoDB is a hosted NoSQL database offered by Amazon Web Services (AWS).

Configuration

1. Start your DynamoDB instance.
2. Add required configuration to your `endpoints.yml`:

```yaml
tracker_store:
    type: dynamo
    tablename: <name of the table to create, e.g. rasa>
    region: <name of the region associated with the client>
```

## [Custom Tracker Store](https://legacy-docs-v1.rasa.com/1.10.1/api/tracker-stores/#id9)

Description

If you require a tracker store which is not available out of the box, you can implement your own. This is done by extending the base class `TrackerStore`.

---
