influxd generate help-schema

    1. title = "Documented schema"
    3. # limit the maximum number of series generated across all measurements
    4. #
    5. # series-limit: integer, optional (default: unlimited)
    7. [[measurements]]
    9. # name of measurement
    10. #
    11. # NOTE:
    12. # Multiple definitions of the same measurement name are allowed and
    13. # will be merged together.
    14. name = "cpu"
    16. # sample: float; where 0 < sample ≤ 1.0 (default: 0.5)
    17. #   sample a subset of the tag set
    18. #
    19. # sample 25% of the tags
    20. #
    21. sample = 0.25
    23. # Keys for defining a tag
    24. #
    25. # name: string, required
    26. #   Name of field
    27. #
    28. # source: array<string> or object
    29. #
    30. #   A literal array of string values defines the tag values.
    31. #
    32. #   An object defines more complex generators. The type key determines the
    33. #   type of generator.
    34. #
    35. # source types:
    36. #
    37. # type: "sequence"
    38. #   generate a sequence of tag values
    39. #
    40. #       format: string
    41. #           a format string for the values (default: "value%s")
    42. #       start: int (default: 0)
    44. #       count: int, required
    45. #           ending value
    46. #
    47. # type: "file"
    48. #   generate a sequence of tag values from a file source.
    49. #   The data in the file is sorted, deduplicated and verified is valid UTF-8
    50. #
    51. #       path: string
    52. #           absolute path or relative path to current toml file
    53.     # example sequence tag source. The range of values are automatically
    54.     # prefixed with 0s
    55.     # to ensure correct sort behavior.
    56.     { name = "host", source = { type = "sequence", format = "host-%s", start = 0, count = 5 } },
    58.     # tags can also be sourced from a file. The path is relative to the
    59.     # schema.toml.
    60.     # Each value must be on a new line. The file is also sorted, deduplicated
    61.     # and UTF-8 validated.
    62.     { name = "rack", source = { type = "file", path = "files/racks.txt" } },
    64.     # Example string array source, which is also deduplicated and sorted
    65.     { name = "region", source = ["us-west-01","us-west-02","us-east"] },
    66. ]
    68. # Keys for defining a field
    69. #
    70. # name: string, required
    71. #   Name of field
    72. #
    73. # count: int, required
    74. #   The maximum number of values to generate. When multiple fields
    75. #   have the same count and time-spec, they will share timestamps.
    76. #
    77. # A time-spec can be either time-precision or time-interval, which
    78. # determines how timestamps are generated and may also influence
    79. # the time range and number of values generated.
    80. #
    81. # time-precision: string [ns, us, ms, s, m, h] (default: ms)
    82. #   Specifies the precision (rounding) for generated timestamps.
    83. #
    84. #   If the precision results in fewer than "count" intervals for the
    85. #   given time range, the number of values will be reduced.
    86. #
    87. #   Example:
    88. #      count = 1000, start = 0s, end = 100s, time-precison = s
    89. #      100 values will be generated at [0s, 1s, 2s, ..., 99s]
    90. #
    91. #   If the precision results in greater than "count" intervals for the
    92. #   given time range, the interval will be rounded to the nearest multiple of
    93. #   time-precision.
    94. #
    95. #   Example:
    96. #      count = 10, start = 0s, end = 100s, time-precison = s
    97. #      100 values will be generated at [0s, 10s, 20s, ..., 90s]
    98. #
    99. # time-interval: Go duration string (eg 90s, 1h30m)
    100. #   Specifies the delta between generated timestamps.
    101. #
    102. #   If the delta results in fewer than "count" intervals for the
    104. #
    105. #   Example:
    106. #      count = 100, start = 0s, end = 100s, time-interval = 10s
    107. #      10 values will be generated at [0s, 10s, 20s, ..., 90s]
    108. #   If the delta results in greater than "count" intervals for the
    109. #   given time range, the start-time will be adjusted to ensure "count" values.
    110. #
    111. #   Example:
    112. #      count = 20, start = 0s, end = 1000s, time-interval = 10s
    113. #      20 values will be generated at [800s, 810s, ..., 900s, ..., 990s]
    114. #
    115. # source: int, float, boolean, string, array or object
    116. #
    117. #   A literal int, float, boolean or string will produce
    118. #   a constant value of the same data type.
    119. #
    120. #   A literal array of homogeneous values will generate a repeating
    121. #   sequence.
    122. #
    123. #   An object defines more complex generators. The type key determines the
    124. #   type of generator.
    125. #
    126. # source types:
    127. #
    128. # type: "rand<float>"
    129. #   generate random float values
    130. #       seed: seed to random number generator (default: 0)
    131. #       min:  minimum value (default: 0.0)
    132. #       max:  maximum value (default: 1.0)
    133. #
    134. # type: "zipf<integer>"
    135. #   generate random integer values using a Zipf distribution
    136. #   The generator generates values k ∈ [0, imax] such that P(k)
    137. #   is proportional to (v + k) ** (-s). Requirements: s > 1 and v ≥ 1.
    138. #   See https://golang.org/pkg/math/rand/#NewZipf for more information.
    139. #
    140. #       seed: seed to random number generator (default: 0)
    141. #       s:    float > 1 (required)
    142. #       v:    float ≥ 1 (required)
    143. #       imax: integer (required)
    144. #
    145. fields = [
    146.     # Example constant float
    147.     { name = "system", count = 5000, source = 2.5 },
    149.     # Example random floats
    150.     { name = "user",   count = 5000, source = { type = "rand<float>", seed = 10, min = 0.0, max = 1.0 } },
    151. ]
    153. # Multiple measurements may be defined.
    154. [[measurements]]
    155. name = "mem"
    156. tags = [
    157.     { name = "host",   source = { type = "sequence", format = "host-%s", start = 0, count = 5 } },
    158.     { name = "region", source = ["us-west-01","us-west-02","us-east"] },
    159. ]
    160. fields = [
    161.     # An example of a sequence of integer values
    162.     { name = "free",    count = 100, source = [10,15,20,25,30,35,30], time-precision = "ms" },
    163. ]

    sample-data