search

sensu / sensu-go

Simple. Scalable. Multi-cloud monitoring.
https://sensu.io
MIT License
1.03k stars 175 forks source link

Add support escape special characters in InfluxDB Line (for 6.x) #5031

Closed jadiunr closed 1 year ago

jadiunr commented 1 year ago

What is this change?

5030 Implementation.

Why is this change necessary?

Here is also #5030 as shown.

Does your change need a Changelog entry?

Yes. Added. This is an extension of the existing InfluxDB Line format, so it is marked as Added instead of Changed.

Do you need clarification on anything?

Were there any complications while making this change?

Have you reviewed and updated the documentation for this change? Is new documentation required?

No. I do not think there is any need for this.

How did you verify this change?

Tested with Mimir 2.9.0 and InfluxDB 2.7.1. Both confirm that the metrics are stored correctly.

spoilers - CheckConfig ```yaml --- type: CheckConfig api_version: core/v2 metadata: name: output_metrics_as_influxdb_line spec: command: | cat << 'EOS' test_metrics1,test_tag1=foo,test_tag2=bar value=1 test_metrics2,test_tag1=ho\ ge,test_tag2=hu\,ga,test_tag3=hi\=ge,test_tag4=ha"ge value=1 EOS output_metric_format: influxdb_line output_metric_handlers: - mimir - influxdb subscriptions: - test interval: 15 publish: true ``` - Handlers ```yaml --- type: Handler api_version: core/v2 metadata: name: influxdb spec: command: 'sensu-influxdb-handler -a http://i:8086 -b default -c -o test -t hogehogeunko' type: pipe runtime_assets: - sensu-influxdb-handler --- type: Asset api_version: core/v2 metadata: name: sensu-influxdb-handler labels: annotations: io.sensu.bonsai.url: https://bonsai.sensu.io/assets/sensu/sensu-influxdb-handler io.sensu.bonsai.api_url: https://bonsai.sensu.io/api/v1/assets/sensu/sensu-influxdb-handler io.sensu.bonsai.tier: Supported io.sensu.bonsai.version: 4.0.0 io.sensu.bonsai.namespace: sensu io.sensu.bonsai.name: sensu-influxdb-handler io.sensu.bonsai.tags: '' spec: builds: - url: https://assets.bonsai.sensu.io/4ef9132e9c75e90db0625f81f54e16b258065bed/sensu-influxdb-handler_4.0.0_linux_amd64.tar.gz sha512: 86fa6645b7a103cda393fb1611c29a2f6cbf4283d800ded8c3a3bbcdc6279d2d2e235331a092f580bd18a2b1b7a3f095612d80bb265b3e70ddb75236ae6aae60 filters: - entity.system.os == 'linux' - entity.system.arch == 'amd64' - url: https://assets.bonsai.sensu.io/4ef9132e9c75e90db0625f81f54e16b258065bed/sensu-influxdb-handler_4.0.0_linux_386.tar.gz sha512: 9e0386f053478e36307665ccda72091c56a53bd69397d71a5200e3003f1e33f7cb6cd2ce210cfdc1af598322de279ef5513ca2f17bbca23bf4bbdd88a06ad279 filters: - entity.system.os == 'linux' - entity.system.arch == '386' - url: https://assets.bonsai.sensu.io/4ef9132e9c75e90db0625f81f54e16b258065bed/sensu-influxdb-handler_4.0.0_linux_arm64.tar.gz sha512: adf3c9e4f0d2840b11736fae446b22534a54818081361ab94d0e073cdcfcc74ea78e7c9d951f7976eae64e8a4954b65d312a7b6a7e0db16328b9aeedd3c6f546 filters: - entity.system.os == 'linux' - entity.system.arch == 'arm64' - url: https://assets.bonsai.sensu.io/4ef9132e9c75e90db0625f81f54e16b258065bed/sensu-influxdb-handler_4.0.0_linux_armv7.tar.gz sha512: 19a9ccbbf05e80298aa35b657426e91781034f3eba3fc877c9f19622b2592aeedba363c9fb3c76bc4410e4122a04c43c781d42304a9009fcb125538438260393 filters: - entity.system.os == 'linux' - entity.system.arch == 'armv7' - url: https://assets.bonsai.sensu.io/4ef9132e9c75e90db0625f81f54e16b258065bed/sensu-influxdb-handler_4.0.0_darwin_amd64.tar.gz sha512: a1b3d0a8ec1ce2b82413f5799fd782e0a53155de58312559a22b7901b2ecfa403deea30f023cf3c5755bb3410456b94aa004136b1247f6aa08738b4fbe98f1bc filters: - entity.system.os == 'darwin' - entity.system.arch == 'amd64' - url: https://assets.bonsai.sensu.io/4ef9132e9c75e90db0625f81f54e16b258065bed/sensu-influxdb-handler_4.0.0_windows_amd64.tar.gz sha512: 92e77345bd5daa8d92b2acce8f2e7cdc7db2e6223f26c904e00507b17dd50e386602156dff02d93c5342da653b3c343cffbca8f08680c73d055f05d3bad3e919 filters: - entity.system.os == 'windows' - entity.system.arch == 'amd64' --- type: Handler api_version: core/v2 metadata: name: mimir spec: command: 'sensu-prometheus-remote-write-handler -e http://m:8080/api/v1/push -H "X-Scope-OrgID: test"' type: pipe runtime_assets: - sensu-prometheus-remote-write-handler --- type: Asset api_version: core/v2 metadata: name: sensu-prometheus-remote-write-handler labels: annotations: io.sensu.bonsai.url: https://bonsai.sensu.io/assets/jadiunr/sensu-prometheus-remote-write-handler io.sensu.bonsai.api_url: https://bonsai.sensu.io/api/v1/assets/jadiunr/sensu-prometheus-remote-write-handler io.sensu.bonsai.tier: Community io.sensu.bonsai.version: 0.1.0 io.sensu.bonsai.namespace: jadiunr io.sensu.bonsai.name: sensu-prometheus-remote-write-handler io.sensu.bonsai.tags: '' spec: builds: - url: https://assets.bonsai.sensu.io/3800f9a28de1fcbfd0cd5f101f19c4bd333f4cfb/sensu-prometheus-remote-write-handler_0.1.0_linux_amd64.tar.gz sha512: a79aeb5a4e5817bf6360f6b2429dcb4321ff1b3728a429afb515e80fef59a1e86c7be26cf604044a7d7b5cd1e664a23623e46fa938099be0549ad26ee2e7e907 filters: - entity.system.os == 'linux' - entity.system.arch == 'amd64' - url: https://assets.bonsai.sensu.io/3800f9a28de1fcbfd0cd5f101f19c4bd333f4cfb/sensu-prometheus-remote-write-handler_0.1.0_linux_arm64.tar.gz sha512: 41f041a8df6565d07b0fe07222fd97fa21d4718b0e13f55a1ae4dfa96b5fec7715b45711c67bdedf0be9313ba44bbacb05e1a585e3473c6c5aab190e2de59de9 filters: - entity.system.os == 'linux' - entity.system.arch == 'arm64' - url: https://assets.bonsai.sensu.io/3800f9a28de1fcbfd0cd5f101f19c4bd333f4cfb/sensu-prometheus-remote-write-handler_0.1.0_linux_armv7.tar.gz sha512: 3ce5c37b9e57e8c82d279fccb94f269677df4b784d0ec0a522c812c584aee530d0a3bf223a046fc7afa0d31e9167c084b0b591d69d74c5d44665447685e0be87 filters: - entity.system.os == 'linux' - entity.system.arch == 'arm' - entity.system.arm_version == 7 - url: https://assets.bonsai.sensu.io/3800f9a28de1fcbfd0cd5f101f19c4bd333f4cfb/sensu-prometheus-remote-write-handler_0.1.0_linux_armv6.tar.gz sha512: a956938e7e8c512c9ce9b05f0375f175593834138cf18f9586699bca21ffa5ec4652c5aa2280d51b999241f3b55d335dd0d9d53be7e8bde464a1d324050bc8f4 filters: - entity.system.os == 'linux' - entity.system.arch == 'arm' - entity.system.arm_version == 6 - url: https://assets.bonsai.sensu.io/3800f9a28de1fcbfd0cd5f101f19c4bd333f4cfb/sensu-prometheus-remote-write-handler_0.1.0_linux_386.tar.gz sha512: 4566ec88aff0af47dd44467b893ed6649927d18bb0624a371d07a1f9ac3a070c80dd9d9fa03cf22b10f205937ff7f70028a18d7d835757055501015a979e4cfe filters: - entity.system.os == 'linux' - entity.system.arch == '386' - url: https://assets.bonsai.sensu.io/3800f9a28de1fcbfd0cd5f101f19c4bd333f4cfb/sensu-prometheus-remote-write-handler_0.1.0_darwin_amd64.tar.gz sha512: 06ae5e5c24efae30a527f0bafc242d6183718da6a21afa9391bfd142e87a047be1ad009b48e0f606101fdd9322406eb63574af147f653524578c088291905e51 filters: - entity.system.os == 'darwin' - entity.system.arch == 'amd64' - url: https://assets.bonsai.sensu.io/3800f9a28de1fcbfd0cd5f101f19c4bd333f4cfb/sensu-prometheus-remote-write-handler_0.1.0_windows_amd64.tar.gz sha512: 42617eaa5b482d1cb8a05d2e2aa6bc5f08d21f07b013a8515790d0f54bd9d4e0459a2788a4df5b3390a25bc21d192cb26685f9c9a49c7b676a380f5f84ef8c92 filters: - entity.system.os == 'windows' - entity.system.arch == 'amd64' ```

Is this change a patch?

No.

echlebek commented 1 year ago

While we are trying to avoid non-patch changes to the 6.x branch, I think this change is small enough that it's probably OK.