Migrate data from TSM to InfluxDB Cloud Serverless

To migrate data from an InfluxDB Cloud (TSM) organization to an InfluxDB Cloud Serverless organization powered by the v3 storage engine, query the data from your TSM-powered buckets in time-based batches and write the queried data to a bucket in your InfluxDB Cloud Serverless organization. Because full data migrations will likely exceed your organizations’ limits and adjustable quotas, migrate your data in batches.

The following guide provides instructions for setting up an InfluxDB task that queries data from an InfluxDB Cloud TSM-powered bucket in time-based batches and writes each batch to an InfluxDB Cloud Serverless (InfluxDB v3) bucket in another organization.

All query and write requests are subject to your InfluxDB Cloud organization’s rate limits and adjustable quotas.

Before you migrate
Set up the migration
Migration task
Monitor the migration progress
Troubleshoot migration task failures

Before you migrate

Before you migrate from InfluxDB Cloud (TSM) to InfluxDB Cloud Serverless, there are schema design practices supported by the TSM storage engine that are not supported in the InfluxDB v3 storage engine. Specifically, InfluxDB v3 enforces the following schema restrictions:

You can’t use duplicate names for tags and fields
Measurements can contain up to 200 columns where each column represents time, a field, or a tag.

For more information, see Schema restrictions.

If your schema does not adhere to these restrictions, you must update your schema before migrating to InfluxDB Cloud Serverless.

Fix duplicate tag and field names

Fix measurements with more than 200 total columns

If in your current schema, the number total number of tags, fields, and time columns in a single measurement exceeds 200, you need to update your schema before migrating to InfluxDB Cloud Serverless. Because tags are metadata use to identify specific series, we recommend splitting groups of fields across multiple measurements.

In the migration Flux script below, add a custom function that determines what measurement a field should be written to based on predefined groups of fields. Call the new custom function from within the existing the data() function. For example:

// ...

groupFieldsIntoMeasurements = (tables=<-) => {
    group1 = 
        tables
            |> filter(fn: (r) =>
                r._field == "example-field-1"
                or r._field == "example-field-2"
                or r._field == "example-field-3"
                or r._field == "example-field-4"
                or r._field == "example-field-5"
            )
            |> set(key: "_measurement", value: "example-measurement-1" )
    group2 = 
        tables
            |> filter(fn: (r) =>
                r._field == "example-field-6"
                or r._field == "example-field-7"
                or r._field == "example-field-8"
                or r._field == "example-field-9"
                or r._field == "example-field-10"
            )
            |> set(key: "_measurement", value: "example-measurement-2" )
    group3 = 
        tables
            |> filter(fn: (r) =>
                r._field == "example-field-11"
                or r._field == "example-field-12"
                or r._field == "example-field-13"
                or r._field == "example-field-14"
                or r._field == "example-field-15"
            )
            |> set(key: "_measurement", value: "example-measurement-3" )
    
    return union(tables: [group1, group2, group3])
}

// Query all data from the specified source bucket within the batch-defined time
// range. To limit migrated data by measurement, tag, or field, add a `filter()`
// function after `range()` with the appropriate predicate fn.
data = () =>
    from(bucket: migration.sourceBucket)
        |> range(start: batch.start, stop: batch.stop)
        |> groupFieldsIntoMeasurements()

// ...

Set up the migration

The migration process requires two buckets in your source InfluxDB organization: one bucket to store the data you’re migrating and a second bucket to store migration metadata. If you’re using the InfluxDB Cloud Free Plan, and have more than one bucket to migrate, you will exceed your plan’s bucket limit. To migrate more than one bucket, you need to upgrade to the Usage-based plan to complete the migration.

In the InfluxDB Cloud Serverless organization you’re migrating data to:
1. Create a bucket to migrate data to.
2. Create an API token with write access to the bucket you want to migrate to.
In the InfluxDB Cloud (TSM) organization you’re migrating data from:
1. Add the InfluxDB Cloud API token from the InfluxDB Cloud Serverless organization (created in step 1b) as a secret using the key, INFLUXDB_SERVERLESS_TOKEN. See Add secrets for more information.
2. Create a bucket to store temporary migration metadata.
3. Create a task using the provided migration task. Update the necessary migration configuration options.
4. (Optional) Set up migration monitoring.
5. Save the task.
  Newly-created tasks are enabled by default, so the data migration begins when you save the task.

After the migration is complete, each subsequent migration task execution will fail with the following error:

error exhausting result iterator: error calling function "die" @41:9-41:86:
Batch range is beyond the migration range. Migration is complete.

Migration task

Configure the migration

Specify how often you want the task to run using the task.every option. See Determine your task interval.
Define the following properties in the migration record:
migration
- start: Earliest time to include in the migration. See Determine your migration start time.
- stop: Latest time to include in the migration.
- batchInterval: Duration of each time-based batch. See Determine your batch interval.
- batchBucket: InfluxDB Cloud (TSM) bucket to store migration batch metadata in.
- sourceBucket: InfluxDB Cloud (TSM) bucket to migrate data from.
- destinationHost: InfluxDB Cloud Serverless region URL to migrate data from.
- destinationOrg: InfluxDB Cloud Serverless organization to migrate data to.
- destinationToken: InfluxDB Cloud Serverless API token. To keep the API token secure, store it as a secret in InfluxDB Cloud (TSM).
- destinationBucket: InfluxDB OSS bucket to migrate data to.

Migration Flux script

import "array"
import "experimental"
import "date"
import "influxdata/influxdb/secrets"

// Configure the task
option task = {every: 5m, name: "Migrate data from TSM to v3"}

// Configure the migration
migration = {
    start: 2022-01-01T00:00:00Z,
    stop: 2022-02-01T00:00:00Z,
    batchInterval: 1h,
    batchBucket: "migration",
    sourceBucket: "example-cloud-bucket",
    destinationHost: "https://cloud2.influxdata.com",
    destinationOrg: "example-destination-org",
    destinationToken: secrets.get(key: "INFLUXDB_SERVERLESS_TOKEN"),
    destinationBucket: "example-destination-bucket",
}

// batchRange dynamically returns a record with start and stop properties for
// the current batch. It queries migration metadata stored in the
// `migration.batchBucket` to determine the stop time of the previous batch.
// It uses the previous stop time as the new start time for the current batch
// and adds the `migration.batchInterval` to determine the current batch stop time.
batchRange = () => {
    _lastBatchStop =
        (from(bucket: migration.batchBucket)
            |> range(start: migration.start)
            |> filter(fn: (r) => r._field == "batch_stop")
            |> filter(fn: (r) => r.dstOrg == migration.destinationOrg)
            |> filter(fn: (r) => r.dstBucket == migration.destinationBucket)
            |> last()
            |> findRecord(fn: (key) => true, idx: 0))._value
    _batchStart =
        if exists _lastBatchStop then
            time(v: _lastBatchStop)
        else
            migration.start

    return {start: _batchStart, stop: date.add(d: migration.batchInterval, to: _batchStart)}
}

// Define a static record with batch start and stop time properties
batch = batchRange()

// Check to see if the current batch start time is beyond the migration.stop
// time and exit with an error if it is.
finished =
    if batch.start >= migration.stop then
        die(msg: "Batch range is beyond the migration range. Migration is complete.")
    else
        "Migration in progress"

// Query all data from the specified source bucket within the batch-defined time
// range. To limit migrated data by measurement, tag, or field, add a `filter()`
// function after `range()` with the appropriate predicate fn.
data = () =>
    from(bucket: migration.sourceBucket)
        |> range(start: batch.start, stop: batch.stop)

// rowCount is a stream of tables that contains the number of rows returned in
// the batch and is used to generate batch metadata.
rowCount =
    data()
        |> count()
        |> group(columns: ["_start", "_stop"])
        |> sum()

// emptyRange is a stream of tables that acts as filler data if the batch is
// empty. This is used to generate batch metadata for empty batches and is
// necessary to correctly increment the time range for the next batch.
emptyRange = array.from(rows: [{_start: batch.start, _stop: batch.stop, _value: 0}])

// metadata returns a stream of tables representing batch metadata.
metadata = () => {
    _input =
        if exists (rowCount |> findRecord(fn: (key) => true, idx: 0))._value then
            rowCount
        else
            emptyRange

    return
        _input
            |> map(
                fn: (r) =>
                    ({
                        _time: now(),
                        _measurement: "batches",
                        srcBucket: migration.sourceBucket,
                        dstOrg: migration.destinationOrg,
                        dstBucket: migration.destinationBucket,
                        batch_start: string(v: batch.start),
                        batch_stop: string(v: batch.stop),
                        rows: r._value,
                        percent_complete:
                            float(v: int(v: r._stop) - int(v: migration.start)) / float(
                                    v: int(v: migration.stop) - int(v: migration.start),
                                ) * 100.0,
                    }),
            )
            |> group(columns: ["_measurement", "dstOrg", "srcBucket", "dstBucket"])
}

// Write the queried data to the specified InfluxDB OSS bucket.
data()
    |> to(
        host: migration.destinationHost,
        org: migration.destinationOrg,
        token: migration.destinationToken,
        bucket: migration.destinationBucket
    )

// Generate and store batch metadata in the migration.batchBucket.
metadata()
    |> experimental.to(bucket: migration.batchBucket)

Configuration help

Determine your task interval

Determine your migration start time

Determine your batch interval

The migration.batchInterval setting controls the time range queried by each batch. The “density” of the data in your InfluxDB Cloud bucket and your InfluxDB Cloud organization’s rate limits and quotas determine what your batch interval should be.

For example, if you’re migrating data collected from hundreds of sensors with points recorded every second, your batch interval will need to be shorter. If you’re migrating data collected from five sensors with points recorded every minute, your batch interval can be longer. It all depends on how much data gets returned in a single batch.

If points occur at regular intervals, you can get a fairly accurate estimate of how much data will be returned in a given time range by using the /api/v2/query endpoint to execute a query for the time range duration and then measuring the size of the response body.

The following curl command queries an InfluxDB Cloud bucket for the last day and returns the size of the response body in bytes. You can customize the range duration to match your specific use case and data density.

INFLUXDB_CLOUD_ORG=<your_influxdb_cloud_org>
INFLUXDB_CLOUD_TOKEN=<your_influxdb_cloud_token>
INFLUXDB_CLOUD_BUCKET=<your_influxdb_cloud_bucket>

curl -so /dev/null --request POST \
  https://cloud2.influxdata.com/api/v2/query?org=$INFLUXDB_CLOUD_ORG  \
  --header "Authorization: Token $INFLUXDB_CLOUD_TOKEN" \
  --header "Accept: application/csv" \
  --header "Content-type: application/vnd.flux" \
  --data "from(bucket:\"$INFLUXDB_CLOUD_BUCKET\") |> range(start: -1d, stop: now())" \
  --write-out '%{size_download}'

You can also use other HTTP API tools like Postman that provide the size of the response body.

Divide the output of this command by 1000000 to convert it to megabytes (MB).

batchInterval = (write-rate-limit-mb / response-body-size-mb) * range-duration

For example, if the response body of your query that returns data from one day is 1 MB and you’re using the InfluxDB Cloud Free Plan with a write limit of 5 MB per five minutes:

batchInterval = (5 / 1) * 1d
// batchInterval = 5d

You could query 5 days of data before hitting your write limit, but this is just an estimate. We recommend setting the batchInterval slightly lower than the calculated interval to allow for variation between batches.

So in this example, it would be best to set your batchInterval to 4d.

Important things to note

This assumes no other queries are running in your source InfluxDB Cloud organization.
This assumes no other writes are happening in your destination InfluxDB Cloud Serverless organization.

Monitor the migration progress

The InfluxDB TSM to Serverless Migration Community template installs the migration task outlined in this guide as well as a dashboard for monitoring running data migrations.

Install the InfluxDB Cloud Migration template

Troubleshoot migration task failures

If the migration task fails, view your task logs to identify the specific error. Below are common causes of migration task failures.

Exceeded rate limits
Invalid API token
Query timeout
Batch size is too large

Exceeded rate limits

If your data migration causes you to exceed your InfluxDB Cloud organization’s limits and quotas, the task will return an error similar to:

too many requests

Possible solutions:

Update the migration.batchInterval setting in your migration task to use a smaller interval. Each batch will then query less data.

Invalid API token

If the API token you add as the INFLUXDB_CLOUD_SECRET doesn’t have read access to your InfluxDB Cloud bucket, the task will return an error similar to:

unauthorized access

Possible solutions:

Ensure the API token has read access to your InfluxDB Cloud bucket.
Generate a new InfluxDB Cloud API token with read access to the bucket you want to migrate. Then, update the INFLUXDB_CLOUD_TOKEN secret in your InfluxDB OSS instance with the new token.

Query timeout

The InfluxDB Cloud query timeout is 90 seconds. If it takes longer than this to return the data from the batch interval, the query will time out and the task will fail.

Possible solutions:

Update the migration.batchInterval setting in your migration task to use a smaller interval. Each batch will then query less data and take less time to return results.

Batch size is too large

If your batch size is too large, the task returns an error similar to the following:

internal error: error calling function "metadata" @97:1-97:11: error calling function "findRecord" @67:32-67:69: wrong number of fields

Possible solutions:

Update the migration.batchInterval setting in your migration task to use a smaller interval and retrieve less data per batch.

Was this page helpful?

Thank you for your feedback!

Support and feedback

Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:

Customers with an annual or support contract can contact InfluxData Support.

Edit this page Submit docs issue Submit InfluxDB issue

Migrate data from TSM to InfluxDB Cloud Serverless

Before you migrate

Set up the migration

Migration task

Configure the migration

migration

Migration Flux script

Configuration help

Important things to note

Monitor the migration progress

Troubleshoot migration task failures

Exceeded rate limits

Invalid API token

Query timeout

Batch size is too large

Support and feedback

Select your InfluxDB Cloud Serverless region

AWS

Thank you for your feedback!

The future of Flux

InfluxDB Cloud Serverless