Skip to main content

Tracker Stores

InMemoryTrackerStore (default)​

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​

No configuration is needed to use the InMemoryTrackerStore.

SQLTrackerStore​

You can use an SQLTrackerStore to store your assistant's conversation history in an SQL database.

Configuration​

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

  1. Add required configuration to your endpoints.yml:
endpoints.yml
tracker_store:
    type: SQL
    dialect: "postgresql"  # the dialect used to interact with the db
    url: ""  # (optional) host of the sql db, e.g. "localhost"
    db: "rasa"  # path to your db
    username:  # username used for authentication
    password:  # password used for authentication
    query: # optional dictionary to be added as a query string to the connection URL
      driver: my-driver
  1. To start the Rasa server using your SQL backend, add the --endpoints flag, e.g.:
rasa run -m models --endpoints endpoints.yml

Configuration Parameters​

  • domain (default: None): Domain object associated with this tracker store

  • dialect (default: sqlite): The dialect used to communicate with your SQL backend. Consult the SQLAlchemy docs for available dialects.

  • url (default: None): URL of your SQL server

  • port (default: None): Port of your SQL server

  • db (default: rasa.db): The path to the database to be used

  • username (default: None): The username which is used for authentication

  • password (default: None): The password which is used for authentication

  • event_broker (default: None): Event broker to publish events to

  • login_db (default: None): Alternative database name to which initially connect, and create the database specified by db (PostgreSQL only)

  • query (default: None): Dictionary of options to be passed to the dialect and/or the DBAPI upon connect

Compatible Databases​

The following databases are officially compatible with the SQLTrackerStore:

  • PostgreSQL
  • Oracle > 11.0
  • SQLite

Configuring Oracle​

To use the SQLTrackerStore with Oracle, there are a few additional steps. First, create a database tracker in your Oracle database and create a user with access to it. Create a sequence in the database with the following command, where username is the user you created (read more about creating sequences in the Oracle Documentation):

CREATE SEQUENCE username.events_seq;

Next you have to extend the Rasa image to include the necessary drivers and clients. First download the Oracle Instant Client, rename it to oracle.rpm and store it in the directory from where you'll be building the docker image. Copy the following into a file called Dockerfile:

FROM rasa/rasa:latest-full

# Switch to root user to install packages
USER root

RUN apt-get update -qq && apt-get install -y --no-install-recommends alien libaio1 && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

# Copy in oracle instaclient
# https://www.oracle.com/database/technologies/instant-client/linux-x86-64-downloads.html
COPY oracle.rpm oracle.rpm

# Install the Python wrapper library for the Oracle drivers
RUN pip install cx-Oracle

# Install Oracle client libraries
RUN alien -i oracle.rpm

USER 1001

Then build the docker image:

docker build . -t rasa-oracle:latest-oracle-full

Now you can configure the tracker store in the endpoints.yml as described above, and start the container. The dialect parameter with this setup will be oracle+cx_oracle.

Using IAM roles to authenticate to an AWS RDS SQL tracker store​

New in 3.14

You can use IAM authentication to connect to an AWS RDS database without needing to provide a username and password.

If your Rasa instance is running on an AWS service that supports IAM roles (e.g. EC2), you can use IAM authentication to connect to an AWS RDS database without needing to provide a username and password. To do so, you need to ensure that your RDS database is configured to allow IAM authentication. Once your RDS instance is up, connect to it and run the following SQL command to enable IAM authentication for the database user you want to use:

GRANT rds_iam TO <db_username>;

You also need to set up your Rasa instance with an appropriate IAM role that has permission to access the RDS database. The IAM role should include the following permission to allow the IAM role to generate the temporary authentication token for the db user:

{    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "rds-db:connect"
            ],
            "Resource": [
                "arn:aws:rds-db:<region>:<account-id>:dbuser:<DbiResourceId for RDS PostgreSQL>/<db_username>"
            ]
        }
    ]
}

Once you have set up the IAM role and configured your RDS database, you can configure the following environment variables in your Rasa instance:

  • IAM_CLOUD_PROVIDER: Set this to aws.
  • AWS_DEFAULT_REGION: Set this to the AWS region where your RDS database is located.
  • RDS_SQL_DB_AWS_IAM_ENABLED: Set this to true to enable IAM authentication for RDS connections.
  • SQL_TRACKER_STORE_SSL_MODE: Set this to the desired SSL mode for the connection (Check your deployed SQL database documentation for supported values. For example: see PostgreSQL SSL Mode descriptions).
  • SQL_TRACKER_STORE_SSL_ROOT_CERTIFICATE: (Optional) Set this to the path of the CA certificate to use for SSL verification if using verify-ca or verify-full SSL modes. This can be downloaded for the particular region from here.

You will also need to update your endpoints.yml to use the IAM authentication by omitting the password field in the tracker_store configuration:

endpoints.yml
tracker_store:
    type: sql
    dialect: "postgresql"
    url: "<rds-endpoint>"
    db: "<db-name>"
    username: "<db-username>"
    port: 5432

When you start your Rasa instance, it will use the IAM role to generate temporary credentials to log in to the RDS database instead of using static credentials. The temporary credentials will be automatically refreshed every 15 minutes.

RedisTrackerStore​

You can store your assistant's conversation history in Redis by using the RedisTrackerStore. Redis is a fast in-memory key-value store which can optionally also persist data.

High Availability Support​

New in 3.14

Redis high availability support is now available for the RedisTrackerStore. You can now deploy with Redis Cluster for horizontal scaling or Redis Sentinel for automatic failover.

The RedisTrackerStore now supports Redis high availability deployments through Redis Cluster and Redis Sentinel modes, enabling enterprise-grade scalability and reliability for production deployments. The supported deployments are:

  • Redis Cluster Mode: Provides horizontal scaling and is compatible with cloud-hosted Redis services.
  • Redis Sentinel Mode: Offers high availability through automatic master/slave failover.
  • Standard Mode: Maintains backward compatibility with existing single-instance deployments.

Configuration​

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

  1. Add required configuration to your endpoints.yml:
endpoints.yml
tracker_store:
    type: redis
    url: <url of the redis instance, e.g. localhost>
    port: <port of your redis instance, usually 6379>
    key_prefix: <alphanumeric value to prepend to tracker store keys>
    db: <number of your database within redis, e.g. 0. Not used in cluster mode>
    password: <password used for authentication>
    use_ssl: <whether or not the communication is encrypted, default `false`>
    # high availability parameters introduced in 3.14
    deployment_mode: <standard, cluster, or sentinel>
    endpoints: <list of redis cluster/sentinel node addresses in the format host:port, only used in cluster or sentinel mode>
    sentinel_service: <name of the redis sentinel service, only used in sentinel mode>
  1. To start the Rasa server using your SQL backend, add the --endpoints flag, e.g.:
rasa run -m models --endpoints endpoints.yml

Configuration Parameters​

  • url (default: localhost): The url of your redis instance

  • port (default: 6379): The port which redis is running on

  • db (default: 0): The number of your redis database. Ignored in cluster mode as Redis Cluster always uses database 0

  • key_prefix (default: None): The prefix to prepend to tracker store keys. Must be alphanumeric

  • username (default: None): Username used for authentication

  • password (default: None): Password used for authentication (None equals no authentication)

  • record_exp (default: None): Record expiry in seconds

  • use_ssl (default: False): whether or not to use SSL for transit encryption

  • deployment_mode (default: standard): Deployment mode of Redis. One of standard, cluster, or sentinel.

  • endpoints (default: None): List of Redis cluster node addresses in the format host:port. Used for cluster and sentinel modes. For cluster mode, these are cluster node endpoints. For sentinel mode, these are sentinel instance endpoints.

  • sentinel_service (default: mymaster): Name of the Redis sentinel service. Only used in sentinel mode.

Deployment Mode Details​
  • Standard Mode: Connects to a single Redis instance using url and port parameters.
  • Cluster Mode: Connects to a Redis Cluster for horizontal scaling. If endpoints is not provided, falls back to auto-discovery using url and port.
  • Sentinel Mode: Connects to Redis Sentinel for high availability with automatic master/slave failover.

Choosing a Deployment Mode​

  • Use standard mode for simple deployments with a single Redis instance.
  • Use cluster mode for horizontal scaling and when using cloud Redis services that require cluster mode.
  • Use sentinel mode for high availability with master/slave replication and automatic failover.
Using the same redis instance as lock-store and tracker store

You must not use the same Redis instance as both lock store and tracker store. If the Redis instance becomes unavailable, the conversation will hang because there is no fall back mechanism implemented for the lock store (as it is for the tracker store interfaces).

Using IAM to authenticate to AWS ElastiCache for Redis​

New in 3.14

You can use IAM authentication to connect to AWS ElastiCache for Redis without needing to provide static credentials.

If your Rasa instance is running on an AWS service that supports IAM roles (e.g. EC2), you can use IAM authentication to connect to AWS ElastiCache for Redis without needing to provide static credentials. To do so, you need to ensure that your AWS ElastiCache cluster or replication group is configured to allow IAM authentication by creating an AWS ElastiCache user with IAM authentication mode enabled.

You also need to set up your Rasa instance with an appropriate IAM role that has the permissions to access the AWS ElastiCache cluster or replication group:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "elasticache:Connect"
            ],
            "Resource": "*"
        }
    ]
}

Once you have set up the IAM role and configured your ElastiCache cluster or replication group, you can configure the following environment variables in your Rasa instance:

  • IAM_CLOUD_PROVIDER: Set this to aws.
  • AWS_DEFAULT_REGION: Set this to the AWS region where your ElastiCache cluster or replication group is located.
  • AWS_ELASTICACHE_CLUSTER_NAME: Set this to the name of your ElastiCache cluster or replication group.
  • ELASTICACHE_REDIS_AWS_IAM_ENABLED: Set this to true to enable IAM authentication for ElastiCache connections.

You can configure the lock store in your endpoints.yml file to not use a username and password:

endpoints.yml
tracker_store:
    type: redis
    url: "master redis host of your elasticache cluster or replication group"
    port: "6379"
    use_ssl: true
    username: your-iam-username

When you start your Rasa instance, it will use the IAM role to generate temporary credentials to log in to the AWS ElastiCache cluster instead of using static credentials. The temporary credentials will be automatically refreshed every 15 minutes.

MongoTrackerStore​

You can store your assistant's conversation history in MongoDB using the MongoTrackerStore. MongoDB is a free and open-source cross-platform document-oriented NoSQL database.

Configuration​

  1. Add required configuration to your endpoints.yml:
endpoints.yml
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>

You can also add more advanced configurations (like enabling ssl) by appending a parameter to the url field, e.g. mongodb://localhost:27017/?ssl=true.

  1. To start the Rasa server using your configured MongoDB instance, add the --endpoints flag, for example:
rasa run -m models --endpoints endpoints.yml

Configuration Parameters​

  • url (default: mongodb://localhost:27017): URL of your MongoDB

  • db (default: rasa): The database name which should be used

  • username (default: 0): The username which is used for authentication

  • password (default: None): The password which is used for authentication

  • auth_source (default: admin): database name associated with the user's credentials.

  • collection (default: conversations): The collection name which is used to store the conversations

DynamoTrackerStore​

You can store your assistant's conversation history in DynamoDB by using a DynamoTrackerStore. DynamoDB is a hosted NoSQL database offered by Amazon Web Services (AWS).

Configuration​

  1. Add required configuration to your endpoints.yml:
endpoints.yml
tracker_store:
    type: dynamo
    table_name: <name of the table to create, e.g. rasa>
    region: <name of the region associated with the client>
  1. To start the Rasa server using your configured DynamoDB instance, add the --endpoints flag, e.g.:
rasa run -m models --endpoints endpoints.yml

Configuration Parameters​

  • table_name (default: states): name of the DynamoDB table

  • region (default: us-east-1): name of the region associated with the client

info

In case the table with table_name does not exist, Rasa will create it for you when run with single sanic worker.

In case Rasa is run with multiple sanic workers, the table should be created before running Rasa. If it's not found, an error will be logged and an exception will be raised.

Custom Tracker Store​

If you need 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 and one of the provided mixin classes that implement the serialise_tracker method: SerializedTrackerAsText or SerializedTrackerAsDict.

To write a custom tracker store, extend the TrackerStore base class. Your constructor has to provide a parameter host. The constructor also needs to make a super call to the base class TrackerStore using domain and event_broker arguments:

super().__init__(domain, event_broker, **kwargs)

Your custom tracker store class must also implement the following three methods:

  • save: saves the conversation to the tracker store. Must respect the following signature:
    async def save(self, tracker: DialogueStateTracker) -> None:
        """Save tracker to the tracker store.

        Args:
            tracker: Tracker to be saved.
        """
  • retrieve: retrieves tracker for the latest conversation session. Must respect the following signature:
    async def retrieve(self, sender_id: str) -> Optional[DialogueStateTracker]:
        """Retrieve tracker for the given sender_id.

        Args:
            sender_id: Conversation ID to retrieve the tracker for.

        Returns:
            Tracker for the given sender_id.
        """
  • keys: returns the set of values for the tracker store's primary key. Must respect the following signature:
    async def keys(self) -> Iterable[str]:
        """Return the set of values for the tracker store's primary key."""
  • delete: deletes the conversation corresponding to the given sender_id in the tracker store. Must respect the following signature:
    async def delete(self, sender_id: str) -> None:
        """Delete tracker for the given sender_id.

        Args:
            sender_id: Conversation ID to delete the tracker for.
        """

Configuration​

Put the module path to your custom tracker store and the parameters you require in your endpoints.yml:

endpoints.yml
tracker_store:
  type: path.to.your.module.Class
  url: localhost
  a_parameter: a value
  another_parameter: another value

Fallback Tracker Store​

In case the primary tracker store configured in endpoints.yml becomes unavailable, the Rasa agent will issue an error message and fall back on the InMemoryTrackerStore implementation. A new dialogue session will be started for each turn, which will be saved separately in the InMemoryTrackerStore fallback.

As soon as the primary tracker store comes back up, it will replace the fallback tracker store and save the conversation from this point going forward. However, note that any previous states saved in the InMemoryTrackerStore fallback will be lost.

Last updated on