Sending an email notification using alert & notification #100

neerajasjawali · 2023-04-26T04:30:34Z

neerajasjawali
Apr 26, 2023

Hi All,

I am working on a use case to test alert & notification to send an email notification when a device-service is added or deleted. Testing by running EdgeX (Jakarta TLS) security services. Even though the response for subscription and notification is a success (201), I am not able to get the mail notification. There's no error on the metadata logs or the support-notification logs.

metadata configuration.toml:

[Clients]                                                                                                                              
  [Clients.support-notifications]                                                                                                      
  Protocol = "http"                                                                                                                    
  Host = "10.168.1.1"                                                                                                                
  Port = 59860                                                                                                                         
                                                                                                                                       
  [Clients.core-data]                                                                                                                  
  Protocol = "http"                                                                                                                    
  Host = "10.168.1.1"                                                                                                                
  Port = 59880                                                                                                                         
                                                                                                                                       
[Databases]                                                                                                                            
  [Databases.Primary]                                                                                                                  
  Host = "10.168.1.1"                                                                                                                
  Name = "metadata"              
  Password = "password"          
  Username = "meta"              
  Port = 6379                    
  Timeout = 5000                 
  Type = "redisdb"               
                                 
[Notifications]                  
PostDeviceChanges = true         
Slug ='device-change-'  
Content = "Metadata notice: "
Sender = "core-metadata"     
Description = "Metadata device notice"
Label = "metadata"

support-notification configuration.toml:

[Writable.InsecureSecrets.SMTP]
    path = "smtp"                
      [Writable.InsecureSecrets.SMTP.Secrets]
      username = "[email protected]"
      password = "lvcqyhdoclyuwyil"
                    
[Service]                                  
HealthCheckInterval = "10s"
Host = "10.168.1.1"                        
Port = 59860                                     
ServerBindAddr = "" # Leave blank so default to Host value unless different value is needed.
StartupMsg = "This is the Support Notifications Microservice"
MaxResultCount = 1024                            
MaxRequestSize = 0 # Not curently used. Defines the maximum size of http request body in bytes
RequestTimeout = "5s"
  [Service.CORSConfiguration]
  EnableCORS = false                                                                        
  CORSAllowCredentials = false                               
  CORSAllowedOrigin = "https://10.168.1.1"
  CORSAllowedMethods = "GET, POST, PUT, PATCH, DELETE"                                        
  CORSAllowedHeaders = "Authorization, Accept, Accept-Language, Content-Language, Content-Type, X-Correlation-ID"
  CORSExposeHeaders = "Cache-Control, Content-Language, Content-Length, Content-Type, Expires, Last-Modified, Pragma, X-Correlation-ID"
  CORSMaxAge = 3600                                                                           
                              
[Registry]                                  
Host = "10.168.1.1"                                 
Port = 8500                                                                                                      
Type = "consul"                                                                                                                        
                                                      
[Databases]                                                                                                      
  [Databases.Primary]                                                                                                                  
  Host = "10.168.1.1"
  Name = "notifications"
  Port = 6379  
  Timeout = 5000     
  Type = "redisdb"
                     
[Smtp]                 
  Host = "smtp.gmail.com"
  Port = 25          
  Sender = "[email protected]"
  EnableSelfSignedCert = false
  Subject = "EdgeX Notification"
  # SecretPath is used to specify the secret path to store the credential(username and password) for connecting the SMTP server
  # User need to store the credential via the /secret API before sending the email notification
  SecretPath = "smtp"
  # AuthMode is the SMTP authentication mechanism. Currently, "usernamepassword" is the only AuthMode supported by this service, and the secret keys are "username" and "password".
  AuthMode = "usernamepassword"

subscription :

Request:

curl -X 'POST'   'http://10.168.1.1:59860/api/v2/subscription'   -H 'accept: application/json'   -H 'X-Correlation-ID: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835'   -H 'Content-Type: application/json'   -d '[
>   {
>     "apiVersion": "v2",
>     "subscription": {
>       "name": "subscriptionB",
>       "channels": [
>         {
>           "type": "EMAIL",
>           "recipients": [
>             "[email protected]"
>           ]
>         },
>         {
>           "type": "REST",
>           "host": "10.168.1.1",
>           "port": 25,
>           "httpMethod": "GET"
>         }
>       ],
>       "categories": [
>         "daily-notify"
>       ],
>       "labels": [
>         "daily"
>       ],
>       "receiver": "receiverA",
>       "resendLimit": 0,
>       "resendInterval": "1h",
>       "adminState": "UNLOCKED"
>     }
>   }
> ]'

Response:
[{"apiVersion":"v2","statusCode":201,"id":"74814f38-01d8-48b0-97ab-ddf01173b0c0"}]

Notification:

Request:

curl -X 'POST'   'http://10.168.1.1:59860/api/v2/notification'   -H 'accept: application/json'   -H 'X-Correlation-ID: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835'   -H 'Content-Type: application/json'   -d '[
>   {
>     "apiVersion": "v2",
>     "notification": {
>       "category": "daily-notify",
>       "content": "content",
>       "contentType": "string",
>       "description": "device notice",
>       "labels": [
>         "metadata"
>       ],
>       "sender": "core-metadata",
>       "severity": "CRITICAL",
>       "status": "NEW"
>     }
>   }
> ]'

Response:
[{"apiVersion":"v2","statusCode":201,"id":"2f0c3e22-9ef1-4d5b-a523-41a70b595038"}]

Transmission:
Request:
curl -X 'GET' http://10.168.1.1:59860/api/v2/transmission/all

Response:
{"apiVersion":"v2","statusCode":200,"totalCount":0,"transmissions":[]}

SMTP server connection:

telnet smtp.gmail.com 25
Connected to smtp.gmail.com
220 smtp.gmail.com ESMTP o70-20020a62cd49000000b0062dcf5c01f9sm10034329pfg.36 - gsmtp

Kindly help me out.
Thanks in advance.

Answered by cloudxxx8

May 5, 2023

try

curl -X 'POST' \
  'http://10.168.1.1:59860/api/v2/secret' \
  -H 'accept: application/json' \
  -H 'X-Correlation-ID: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835' \
  -H 'Content-Type: application/json' \
  -d '{
  "requestId": "e6e8a2f4-eb14-4649-9e2b-175247911369",
  "apiVersion": "v2",
  "path": "smtp",
  "secretData": [
    {
      "key": "username",
      "value": "[email protected]"
    },
    {
      "key": "password",
      "value": "password"
    }
  ]
}'

View full answer

cloudxxx8 · 2023-04-26T07:57:15Z

cloudxxx8
Apr 26, 2023
Maintainer

please check the notification service log. it's normally the authentication setting issue.
you had better prepare your own SMTP server. the free smtp server setting might be changed constantly due to the security concern.

2 replies

neerajasjawali Apr 26, 2023
Author

Hi @cloudxxx8

In support-notification service log I don't find any error.

level=INFO ts=2023-04-26T04:05:25.270626498Z app=support-notifications source=config.go:373 msg="Loaded service configuration from ./res/configuration.toml"
level=INFO ts=2023-04-26T04:05:25.274666665Z app=support-notifications source=variables.go:352 msg="Variables override of 'SecretStore.Port' by environment variable: SECRETSTORE_PORT=8200"
level=INFO ts=2023-04-26T04:05:25.274909675Z app=support-notifications source=variables.go:352 msg="Variables override of 'SecretStore.Host' by environment variable: SECRETSTORE_HOST=edgex-vault"
level=INFO ts=2023-04-26T04:05:25.275863714Z app=support-notifications source=secret.go:52 msg="Creating SecretClient"
level=INFO ts=2023-04-26T04:05:25.276020721Z app=support-notifications source=secret.go:59 msg="Reading secret store configuration and authentication token"
level=INFO ts=2023-04-26T04:05:25.276622746Z app=support-notifications source=secret.go:71 msg="Attempting to create secret client"
level=INFO ts=2023-04-26T04:05:25.289998298Z app=support-notifications source=secret.go:76 msg="Created SecretClient"
level=INFO ts=2023-04-26T04:05:25.290179305Z app=support-notifications source=secret.go:81 msg="SecretsFile not set, skipping seeding of service secrets."
level=INFO ts=2023-04-26T04:05:25.291557362Z app=support-notifications source=secrets.go:276 msg="kick off token renewal with interval: 30m0s"
level=INFO ts=2023-04-26T04:05:25.322229628Z app=support-notifications source=secrets.go:148 msg="successfully generated Consul token for service support-notifications"
level=INFO ts=2023-04-26T04:05:25.322490638Z app=support-notifications source=config.go:159 msg="Using Configuration Provider access token of length 36"
level=INFO ts=2023-04-26T04:05:25.322715648Z app=support-notifications source=config.go:348 msg="Using Configuration provider (consul) from: http://myhost:8500 with base path of edgex/core/2.0/support-notifications"
level=INFO ts=2023-04-26T04:05:25.367743506Z app=support-notifications source=variables.go:352 msg="Variables override of 'SecretStore.Port' by environment variable: SECRETSTORE_PORT=8200"
level=INFO ts=2023-04-26T04:05:25.368057519Z app=support-notifications source=variables.go:352 msg="Variables override of 'SecretStore.Host' by environment variable: SECRETSTORE_HOST=edgex-vault"
level=INFO ts=2023-04-26T04:05:25.369160564Z app=support-notifications source=config.go:510 msg="Configuration has been pulled from Configuration provider (2 envVars overrides applied)"
level=INFO ts=2023-04-26T04:05:25.399189803Z app=support-notifications source=secrets.go:148 msg="successfully generated Consul token for service support-notifications"
level=INFO ts=2023-04-26T04:05:25.399395812Z app=support-notifications source=registry.go:61 msg="Using Registry access token of length 36"
level=INFO ts=2023-04-26T04:05:25.399535818Z app=support-notifications source=registry.go:85 msg="Using Registry (consul) from http://10.168.1.1:8500"
level=INFO ts=2023-04-26T04:05:25.459873308Z app=support-notifications source=database.go:121 msg="Database for V2 API connected"
level=INFO ts=2023-04-26T04:05:25.46720361Z app=support-notifications source=telemetry.go:86 msg="Telemetry starting"
level=INFO ts=2023-04-26T04:05:25.467645628Z app=support-notifications source=httpserver.go:123 msg="Web server starting (10.168.1.1:59860)"
level=INFO ts=2023-04-26T04:05:25.467843636Z app=support-notifications source=message.go:50 msg="Service dependencies resolved..."
level=INFO ts=2023-04-26T04:05:25.467980642Z app=support-notifications source=message.go:51 msg="Starting support-notifications 0.0.0 "
level=INFO ts=2023-04-26T04:05:25.468137649Z app=support-notifications source=message.go:55 msg="This is the Support Notifications Microservice"
level=INFO ts=2023-04-26T04:05:25.468295655Z app=support-notifications source=message.go:58 msg="Service started in: 201.705323ms"

And how can I create my own SMTP server?

cloudxxx8 Apr 26, 2023
Maintainer

you should ask your IT support about the SMTP server.

cloudxxx8 · 2023-04-26T08:58:51Z

cloudxxx8
Apr 26, 2023
Maintainer

Did you create any Subscription with email channel in this service?

1 reply

neerajasjawali Apr 26, 2023
Author

Yes, I did.

curl -X 'POST'   'http://10.168.1.1:59860/api/v2/subscription'   -H 'accept: application/json'   -H 'X-Correlation-ID: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835'   -H 'Content-Type: application/json'   -d '[
>   {
>     "apiVersion": "v2",
>     "subscription": {
>       "name": "subscriptionB",
>       "channels": [
>         {
>           "type": "EMAIL",
>           "recipients": [
>             "[email protected]"
>           ]
>         },
>         {
>           "type": "REST",
>           "host": "10.168.1.1",
>           "port": 25,
>           "httpMethod": "GET"
>         }
>       ],
>       "categories": [
>         "daily-notify"
>       ],
>       "labels": [
>         "daily"
>       ],
>       "receiver": "receiverA",
>       "resendLimit": 0,
>       "resendInterval": "1h",
>       "adminState": "UNLOCKED"
>     }
>   }
> ]'

cloudxxx8 · 2023-04-26T11:19:16Z

cloudxxx8
Apr 26, 2023
Maintainer

it looks like there are some confusions about the notification design. the "category" and "labels" in the notifications should fully match the subscription. Could you please try to create the Notification without setting the labels?

curl -X 'POST' 'http://10.168.1.1:59860/api/v2/notification' -H 'accept: application/json' -H 'X-Correlation-ID: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835' -H 'Content-Type: application/json' -d '[

{
"apiVersion": "v2",
"notification": {
"category": "daily-notify",
"content": "content",
"contentType": "string",
"description": "device notice",
"sender": "core-metadata",
"severity": "CRITICAL",
"status": "NEW"
}
}
]'

12 replies

neerajasjawali Apr 27, 2023
Author

Any alternate server to use other than SMTP?

cloudxxx8 Apr 27, 2023
Maintainer

email always requires SMTP

neerajasjawali Apr 27, 2023
Author

Even after changing the labels in both notification and subscription, I still am not able to get notification.

cloudxxx8 Apr 29, 2023
Maintainer

did you see the error message from log?

neerajasjawali May 2, 2023
Author

did you see the error message from log?

I am not getting any error.

neerajasjawali · 2023-04-27T09:18:05Z

neerajasjawali
Apr 27, 2023
Author

(https://docs.edgexfoundry.org/2.1/microservices/support/notifications/Ch-AlertsNotifications/#:~:text=For%20EdgeX%202.0%2C%20the%20SMTP%20username%20and%20password%20can%20be%20set%20in%20the%20Writable.InsecureSecrets.SMTP.Secrets%20as%20an%20insecure%20secret%2C%20or%20be%20stored%20in%20the%20Smtp.SecretPath%20for%20security. )

As explained in the link, do I need to add the username and password in Writable.InsecureSecrets.SMTP.Secrets section?

23 replies

cloudxxx8 May 5, 2023
Maintainer

The credential to connect to SMTP

neerajasjawali May 5, 2023
Author

I have to post the username(mail-id) and password(app-password) of gmail account using secret API. Am I correct?

neerajasjawali May 5, 2023
Author

@cloudxxx8, Is it the correct way to post the credential?

curl -X 'POST' \
  'http://10.168.1.1:59860/api/v2/secret' \
  -H 'accept: application/json' \
  -H 'X-Correlation-ID: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835' \
  -H 'Content-Type: application/json' \
  -d '{
  "requestId": "e6e8a2f4-eb14-4649-9e2b-175247911369",
  "apiVersion": "v2",
  "path": "smtp",
  "secretData": [
    {
      "key": "[email protected]",
      "value": "password"
    }
  ]
}'

cloudxxx8 May 5, 2023
Maintainer

try

curl -X 'POST' \
  'http://10.168.1.1:59860/api/v2/secret' \
  -H 'accept: application/json' \
  -H 'X-Correlation-ID: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835' \
  -H 'Content-Type: application/json' \
  -d '{
  "requestId": "e6e8a2f4-eb14-4649-9e2b-175247911369",
  "apiVersion": "v2",
  "path": "smtp",
  "secretData": [
    {
      "key": "username",
      "value": "[email protected]"
    },
    {
      "key": "password",
      "value": "password"
    }
  ]
}'

Answer selected by neerajasjawali

neerajasjawali May 5, 2023
Author

Thank you @cloudxxx8. It's working now. I am able to get the notification

neerajasjawali May 5, 2023
Author

@cloudxxx8, Correct me if I am wrong. To send the notification automatically, I have to add the subscription,notification and smtp secret credential in the support-notifications configuration.toml file.

cloudxxx8 May 5, 2023
Maintainer

yes, but you don't need add notification, but the email is sent when the new notifications with matching category and label comming.

neerajasjawali May 5, 2023
Author

yes, but you don't need add notification, but the email is sent when the new notifications with matching category and label comming.

Okay. I will do the modifications and test. Thank you for the help @cloudxxx8 .

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EdgeX Foundry Project

Sending an email notification using alert & notification #100

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 4 comments 38 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

EdgeX Foundry Project

Sending an email notification using alert & notification #100

neerajasjawali Apr 26, 2023

Replies: 4 comments · 38 replies

cloudxxx8 Apr 26, 2023 Maintainer

neerajasjawali Apr 26, 2023 Author

cloudxxx8 Apr 26, 2023 Maintainer

cloudxxx8 Apr 26, 2023 Maintainer

neerajasjawali Apr 26, 2023 Author

cloudxxx8 Apr 26, 2023 Maintainer

neerajasjawali Apr 27, 2023 Author

cloudxxx8 Apr 27, 2023 Maintainer

neerajasjawali Apr 27, 2023 Author

cloudxxx8 Apr 29, 2023 Maintainer

neerajasjawali May 2, 2023 Author

neerajasjawali Apr 27, 2023 Author

cloudxxx8 May 5, 2023 Maintainer

neerajasjawali May 5, 2023 Author

neerajasjawali May 5, 2023 Author

cloudxxx8 May 5, 2023 Maintainer

neerajasjawali May 5, 2023 Author

neerajasjawali May 5, 2023 Author

cloudxxx8 May 5, 2023 Maintainer

neerajasjawali May 5, 2023 Author

neerajasjawali
Apr 26, 2023

Replies: 4 comments 38 replies

cloudxxx8
Apr 26, 2023
Maintainer

neerajasjawali Apr 26, 2023
Author

cloudxxx8 Apr 26, 2023
Maintainer

cloudxxx8
Apr 26, 2023
Maintainer

neerajasjawali Apr 26, 2023
Author

cloudxxx8
Apr 26, 2023
Maintainer

neerajasjawali Apr 27, 2023
Author

cloudxxx8 Apr 27, 2023
Maintainer

neerajasjawali Apr 27, 2023
Author

cloudxxx8 Apr 29, 2023
Maintainer

neerajasjawali May 2, 2023
Author

neerajasjawali
Apr 27, 2023
Author

cloudxxx8 May 5, 2023
Maintainer

neerajasjawali May 5, 2023
Author

neerajasjawali May 5, 2023
Author

cloudxxx8 May 5, 2023
Maintainer

neerajasjawali May 5, 2023
Author

neerajasjawali May 5, 2023
Author

cloudxxx8 May 5, 2023
Maintainer

neerajasjawali May 5, 2023
Author