ContactPoints: incorrect substitution of enviroment values in yaml config #69950

casnerano · 2023-06-12T18:33:18Z

What went wrong?

What happened:

In configuration file etc/grafana/provisioning/alerting/default.yml

the Point of Contact for the telegram is declared, the ChatId value is taken from the environment variables.

contactPoints:
   - orgId: 1

     name: Telegram
     receivers:
       - uid: telegram_notifier
         type: telegram
         settings:
           bottoken: $TELEGRAM_TOKEN
           chatid: $TELEGRAM_CHAT_ID

env variable value
TELEGRAM_CHAT_ID="-808008888"

When starting grafana, an error pops up:
Error: ✗ failure to map file default.yml: failure parsing contact points: Telegram: failed to validate receiver of type "telegram": failed to unmarshal settings: json: cannot unmarshal number into Go struct field Config.chatid of type string

The problem is not solved, even if you wrap the value in quotes:
chatid: "$TELEGRAM_CHAT_ID"

The problem was solved temporarily through a crutch:
env variable value TELEGRAM_CHAT_ID="808008888"
in config:

chatid: |-
   -
   $TELEGRAM_CHAT_ID

The problem is that when substituting a value from an environment variable, it is interpreted as a negative number, and not as a string, which the structure expects.

How do we reproduce it?

In configuration file etc/grafana/provisioning/alerting/default.yml

contactPoints:
   - orgId: 1

     name: Telegram
     receivers:
       - uid: telegram_notifier
         type: telegram
         settings:
           bottoken: $TELEGRAM_TOKEN
           chatid: $TELEGRAM_CHAT_ID

where $TELEGRAM_CHAT_ID is number.

What Grafana version are you using?

v9.5.2

Optional Questions:

Is the bug inside a Dashboard Panel?

Copy the panel's "get-help" data here

Grafana Platform?

Docker

User's OS?

No response

User's Browser?

No response

Is this a Regression?

None

Are Datasources involved?

No response

Anything else to add?

No response

The text was updated successfully, but these errors were encountered:

armandgrillet · 2023-06-23T16:16:31Z

We have confirmed the bug. The substitution works for e.g. name but not for what is under settings.

armandgrillet · 2023-06-23T16:20:16Z

The issue is in the https://github.com/grafana/grafana/tree/main/pkg/services/provisioning package

papagian · 2023-07-10T12:52:12Z

@armandgrillet I was able to reproduce the issue but I'm not sure how to fix this:
the error is returned inside grafana/alerting
because Config.ChatID is string and the value is an integer

The chatid value is correct (-808008888) here

alerting.AlertingFileV1

(*alerting.AlertingFileV1)(0x140033747e0)({
 configVersion: (alerting.configVersion) {
  APIVersion: (values.Int64Value) {
   value: (int64) 0,
   Raw: (string) ""
  }
 },
 Filename: (string) "",
 Groups: ([]alerting.AlertRuleGroupV1) <nil>,
 DeleteRules: ([]alerting.RuleDeleteV1) <nil>,
 ContactPoints: ([]alerting.ContactPointV1) (len=1 cap=1) {
  (alerting.ContactPointV1) {
   OrgID: (values.Int64Value) {
    value: (int64) 1,
    Raw: (string) (len=1) "1"
   },
   Name: (values.StringValue) {
    value: (string) (len=8) "Telegram",
    Raw: (string) (len=8) "Telegram"
   },
   Receivers: ([]alerting.ReceiverV1) (len=1 cap=1) {
    (alerting.ReceiverV1) {
     UID: (values.StringValue) {
      value: (string) (len=17) "telegram_notifier",
      Raw: (string) (len=17) "telegram_notifier"
     },
     Type: (values.StringValue) {
      value: (string) (len=8) "telegram",
      Raw: (string) (len=8) "telegram"
     },
     Settings: (values.JSONValue) {
      value: (map[string]interface {}) (len=2) {
       (string) (len=8) "bottoken": (string) "",
       (string) (len=6) "chatid": (int64) -808008888
      },
      Raw: (map[string]interface {}) (len=2) {
       (string) (len=8) "bottoken": (string) (len=15) "$TELEGRAM_TOKEN",
       (string) (len=6) "chatid": (string) (len=17) "$TELEGRAM_CHAT_ID"
      }
     },
     DisableResolveMessage: (values.BoolValue) {
      value: (bool) false,
      Raw: (string) ""
     }
    }
   }
  }
 },
 DeleteContactPoints: ([]alerting.DeleteContactPointV1) <nil>,
 Policies: ([]alerting.NotificiationPolicyV1) <nil>,
 ResetPolicies: ([]values.Int64Value) <nil>,
 MuteTimes: ([]alerting.MuteTimeV1) <nil>,
 DeleteMuteTimes: ([]alerting.DeleteMuteTimeV1) <nil>,
 Templates: ([]alerting.TemplateV1) <nil>,
 DeleteTemplates: ([]alerting.DeleteTemplateV1) <nil>
})

but it's transformed to string in transformInterface()

how do you suggest to catch this case? is there a reason that the Config.ChatID is string instead of integer?

MikhailVorzhev · 2023-10-06T16:45:20Z

Did you manage to solve the problem?
I have similar issue on version 10.x.x. Last working version 9.3.1.

With this commit, the ChatID and MessageThreadID configuration of the Telegram notifier now can be configured either with a string or an integer, without any breaking changes for anyone consuming this library or the end users using it in their configuration files. Fixes grafana/grafana#69950

hassansaadat · 2024-06-27T09:52:41Z

I have this issue in grafana 11.0.0 and managed to handle using this syntax:

  chatid: |
       $TELEGRAM_CHAT_ID

where $TELEGRAM_CHAT_ID is actual chat id (including starting -)

MikhailVorzhev · 2024-07-10T13:09:32Z

I have this issue in grafana 11.0.0 and managed to handle using this syntax:
  chatid: |
       $TELEGRAM_CHAT_ID
where $TELEGRAM_CHAT_ID is actual chat id (including starting -)

It's work for me too. Thanks

With this commit, the ChatID and MessageThreadID configuration of the Telegram notifier now can be configured either with a string or an integer, without any breaking changes for anyone consuming this library or the end users using it in their configuration files. Fixes grafana/grafana#69950

casnerano changed the title ~~Product-Area-Here: short description of bug here~~ ContactPoints: incorrect substitution of enviroment values in yaml config Jun 13, 2023

zuchka added area/alerting Grafana Alerting area/provisioning triage/needs-confirmation used for OSS triage rotation - reported issue needs to be reproduced labels Jun 19, 2023

github-project-automation bot added this to Alerting Jun 19, 2023

armandgrillet added type/bug and removed triage/needs-confirmation used for OSS triage rotation - reported issue needs to be reproduced labels Jun 23, 2023

armandgrillet moved this to Backlog in Alerting Jun 23, 2023

NefixEstrada linked a pull request Jun 5, 2024 that will close this issue

fix(telegram): parse correctly ChatID and MessageThreadID grafana/alerting#198

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ContactPoints: incorrect substitution of enviroment values in yaml config #69950

ContactPoints: incorrect substitution of enviroment values in yaml config #69950

casnerano commented Jun 12, 2023 •

edited

Loading

armandgrillet commented Jun 23, 2023

armandgrillet commented Jun 23, 2023

papagian commented Jul 10, 2023

MikhailVorzhev commented Oct 6, 2023

hassansaadat commented Jun 27, 2024

MikhailVorzhev commented Jul 10, 2024

ContactPoints: incorrect substitution of enviroment values in yaml config #69950

ContactPoints: incorrect substitution of enviroment values in yaml config #69950

Comments

casnerano commented Jun 12, 2023 • edited Loading

What went wrong?

How do we reproduce it?

What Grafana version are you using?

Optional Questions:

Is the bug inside a Dashboard Panel?

Grafana Platform?

User's OS?

User's Browser?

Is this a Regression?

Are Datasources involved?

Anything else to add?

armandgrillet commented Jun 23, 2023

armandgrillet commented Jun 23, 2023

papagian commented Jul 10, 2023

MikhailVorzhev commented Oct 6, 2023

hassansaadat commented Jun 27, 2024

MikhailVorzhev commented Jul 10, 2024

casnerano commented Jun 12, 2023 •

edited

Loading