Migrate data from InfluxDB Cloud to InfluxDB OSS

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

To migrate data from InfluxDB Cloud to InfluxDB OSS, query the data from InfluxDB Cloud and write the data to InfluxDB OSS. Because full data migrations will likely exceed your organization’s limits and adjustable quotas, migrate your data in batches.

The following guide provides instructions for setting up an InfluxDB OSS task that queries data from an InfluxDB Cloud bucket in time-based batches and writes each batch to an InfluxDB OSS bucket.

All queries against data in InfluxDB Cloud are subject to your organization’s rate limits and adjustable quotas.

Set up the migration

  1. Install and set up InfluxDB OSS.

  2. In InfluxDB Cloud, create an API token with read access to the bucket you want to migrate.

  3. In InfluxDB OSS:

    1. Add your InfluxDB Cloud API token as a secret using the key, INFLUXDB_CLOUD_TOKEN. See Add secrets for more information.

    2. Create a bucket to migrate data to.

    3. Create a bucket to store temporary migration metadata.

    4. Create a new task using the provided migration task. Update the necessary migration configuration options.

    5. (Optional) Set up migration monitoring.

    6. 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:

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

Migration task

Configure the migration

  1. Specify how often you want the task to run using the task.every option. See Determine your task interval.

  2. 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 OSS bucket to store migration batch metadata in.
    • sourceHost: InfluxDB Cloud region URL to migrate data from.
    • sourceOrg: InfluxDB Cloud organization to migrate data from.
    • sourceToken: InfluxDB Cloud API token. To keep the API token secure, store it as a secret in InfluxDB OSS.
    • sourceBucket: InfluxDB Cloud bucket to migrate data from.
    • destinationBucket: InfluxDB OSS bucket to migrate data to.

Migration Flux script

  1. import "array"
  2. import "experimental"
  3. import "influxdata/influxdb/secrets"
  5. // Configure the task
  6. option task = {every: 5m, name: "Migrate data from InfluxDB Cloud"}
  8. // Configure the migration
  9. migration = {
  10.     start: 2022-01-01T00:00:00Z,
  11.     stop: 2022-02-01T00:00:00Z,
  12.     batchInterval: 1h,
  13.     batchBucket: "migration",
  14.     sourceHost: "https://cloud2.influxdata.com",
  15.     sourceOrg: "example-cloud-org",
  16.     sourceToken: secrets.get(key: "INFLUXDB_CLOUD_TOKEN"),
  17.     sourceBucket: "example-cloud-bucket",
  18.     destinationBucket: "example-oss-bucket",
  19. }
  21. // batchRange dynamically returns a record with start and stop properties for
  22. // the current batch. It queries migration metadata stored in the
  23. // `migration.batchBucket` to determine the stop time of the previous batch.
  24. // It uses the previous stop time as the new start time for the current batch
  25. // and adds the `migration.batchInterval` to determine the current batch stop time.
  26. batchRange = () => {
  27.     _lastBatchStop =
  28.         (from(bucket: migration.batchBucket)
  29.             |> range(start: migration.start)
  30.             |> filter(fn: (r) => r._field == "batch_stop")
  31.             |> filter(fn: (r) => r.srcOrg == migration.sourceOrg)
  32.             |> filter(fn: (r) => r.srcBucket == migration.sourceBucket)
  33.             |> last()
  34.             |> findRecord(fn: (key) => true, idx: 0))._value
  35.     _batchStart =
  36.         if exists _lastBatchStop then
  37.             time(v: _lastBatchStop)
  38.         else
  39.             migration.start
  41.     return {start: _batchStart, stop: experimental.addDuration(d: migration.batchInterval, to: _batchStart)}
  42. }
  44. // Define a static record with batch start and stop time properties
  45. batch = {start: batchRange().start, stop: batchRange().stop}
  47. // Check to see if the current batch start time is beyond the migration.stop
  48. // time and exit with an error if it is.
  49. finished =
  50.     if batch.start >= migration.stop then
  51.         die(msg: "Batch range is beyond the migration range. Migration is complete.")
  52.     else
  53.         "Migration in progress"
  55. // Query all data from the specified source bucket within the batch-defined time
  56. // range. To limit migrated data by measurement, tag, or field, add a `filter()`
  57. // function after `range()` with the appropriate predicate fn.
  58. data = () =>
  59.     from(host: migration.sourceHost, org: migration.sourceOrg, token: migration.sourceToken, bucket: migration.sourceBucket)
  60.         |> range(start: batch.start, stop: batch.stop)
  62. // rowCount is a stream of tables that contains the number of rows returned in
  63. // the batch and is used to generate batch metadata.
  64. rowCount =
  65.     data()
  66.         |> count()
  67.         |> group(columns: ["_start", "_stop"])
  68.         |> sum()
  70. // emptyRange is a stream of tables that acts as filler data if the batch is
  71. // empty. This is used to generate batch metadata for empty batches and is
  72. // necessary to correctly increment the time range for the next batch.
  73. emptyRange = array.from(rows: [{_start: batch.start, _stop: batch.stop, _value: 0}])
  75. // metadata returns a stream of tables representing batch metadata.
  76. metadata = () => {
  77.     _input =
  78.         if exists (rowCount |> findRecord(fn: (key) => true, idx: 0))._value then
  79.             rowCount
  80.         else
  81.             emptyRange
  83.     return
  84.         _input
  85.             |> map(
  86.                 fn: (r) =>
  87.                     ({
  88.                         _time: now(),
  89.                         _measurement: "batches",
  90.                         srcOrg: migration.sourceOrg,
  91.                         srcBucket: migration.sourceBucket,
  92.                         dstBucket: migration.destinationBucket,
  93.                         batch_start: string(v: batch.start),
  94.                         batch_stop: string(v: batch.stop),
  95.                         rows: r._value,
  96.                         percent_complete:
  97.                             float(v: int(v: r._stop) - int(v: migration.start)) / float(
  98.                                     v: int(v: migration.stop) - int(v: migration.start),
  99.                                 ) * 100.0,
  100.                     }),
  101.             )
  102.             |> group(columns: ["_measurement", "srcOrg", "srcBucket", "dstBucket"])
  103. }
  105. // Write the queried data to the specified InfluxDB OSS bucket.
  106. data()
  107.     |> to(bucket: migration.destinationBucket)
  109. // Generate and store batch metadata in the migration.batchBucket.
  110. metadata()
  111.     |> experimental.to(bucket: migration.batchBucket)

Configuration help

Determine your task interval

The task interval determines how often the migration task runs and is defined by the task.every option. InfluxDB Cloud rate limits and quotas reset every five minutes, so we recommend a 5m task interval.

You can do shorter task intervals and execute the migration task more often, but you need to balance the task interval with your batch interval and the amount of data returned in each batch. If the total amount of data queried in each five-minute interval exceeds your InfluxDB Cloud organization’s rate limits and quotas, the batch will fail until rate limits and quotas reset.

Determine your migration start time

The migration.start time should be at or near the same time as the earliest data point you want to migrate. All migration batches are determined using the migration.start time and migration.batchInterval settings.

To find time of the earliest point in your bucket, run the following query:

  1. from(bucket: "example-cloud-bucket")
  2.     |> range(start: 0)
  3.     |> group()
  4.     |> first()
  5.     |> keep(columns: ["_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.

  1. INFLUXDB_CLOUD_ORG=<your_influxdb_cloud_org>
  2. INFLUXDB_CLOUD_TOKEN=<your_influxdb_cloud_token>
  3. INFLUXDB_CLOUD_BUCKET=<your_influxdb_cloud_bucket>
  5. curl -so /dev/null --request POST \
  6.   https://cloud2.influxdata.com/api/v2/query?org=$INFLUXDB_CLOUD_ORG  \
  7.   --header "Authorization: Token $INFLUXDB_CLOUD_TOKEN" \
  8.   --header "Accept: application/csv" \
  9.   --header "Content-type: application/vnd.flux" \
  10.   --data "from(bucket:\"$INFLUXDB_CLOUD_BUCKET\") |> range(start: -1d, stop: now())" \
  11.   --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).

  1. batchInterval = (read-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 8 MB and you’re using the InfluxDB Cloud Free Plan with a read limit of 300 MB per five minutes:

  1. batchInterval = (300 / 8) * 1d
  2. // batchInterval = 37d

You could query 37 days of data before hitting your read 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 35d.

Important things to note
  • This assumes no other queries are running in your InfluxDB Cloud organization.
  • You should also consider your network speeds and whether a batch can be fully downloaded within the task interval.

Monitor the migration progress

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

InfluxDB Cloud migration dashboard

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

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

  1. 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:

  1. 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.