konevsa/proxmox
1
0
Fork 0
forked from Proxmox/proxmox
Code Pull Requests Activity
5f7ac875f6
proxmox/proxmox-notify/Cargo.toml

35 lines
1.0 KiB
TOML
Raw Normal View History

add proxmox-notify crate Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:30 +03:00
[package]
name = "proxmox-notify"
bump proxmox-notify to 0.2.0 Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2023-07-28 12:33:13 +03:00
version = "0.2.0"
add proxmox-notify crate Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:30 +03:00
authors.workspace = true
edition.workspace = true
license.workspace = true
repository.workspace = true
exclude.workspace = true
[dependencies]
notify: replace filters and groups with matcher-based system This shifts notification routing into the matcher-system. Every notification has associated metadata (key-value fields, severity - to be extended) that can be match with match directives in notification matchers. Right now, there are 2 matching directives, match-field and match-severity. The first one allows one to do a regex match/exact match on a metadata field, the other one allows one to match one or more severites. Every matcher also allows 'target' directives, these decide which target(s) will be notified if a matcher matches a notification. Since routing now happens in matchers, the API for sending is simplified, since we do not need to specify a target any more. The API routes for filters and groups have been removed completely. The parser for the configuration file will still accept filter/group entries, but will delete them once the config is saved again. This is needed to allow a smooth transition from the old system to the new system, since the old system was already available on pvetest. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:13 +03:00
anyhow.workspace = true
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
handlebars = { workspace = true }
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
lazy_static.workspace = true
log.workspace = true
notify: add mechanisms for email message forwarding As preparation for the integration of `proxmox-mail-foward` into the notification system, this commit makes a few changes that allow us to forward raw email messages (as passed from postfix). For mail-based notification targets, the email will be forwarded as-is, including all headers. The only thing that changes is the message envelope. For other notification targets, the mail is parsed using the `mail-parser` crate, which allows us to extract a subject and a body. As a body we use the plain-text version of the mail. If an email is HTML-only, the `mail-parser` crate will automatically attempt to transform the HTML into readable plain text. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:18 +03:00
mail-parser = { workspace = true, optional = true }
notify: add context Since `proxmox-notify` is intended to be used by multiple products, there needs to be a way to inject product-specific behavior. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:44 +03:00
once_cell.workspace = true
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
openssl.workspace = true
notify: add gotify endpoint Add an endpoint for Gotify [1], showing the how easy it is to add new endpoint implementations. [1] https://gotify.net/ Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:36 +03:00
proxmox-http = { workspace = true, features = ["client-sync"], optional = true }
notify: use HttpError from proxmox-http-error Also improve API documentation in terms of which HttpError is returned when. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-26 17:18:23 +03:00
proxmox-http-error.workspace = true
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
proxmox-human-byte.workspace = true
notify: replace filters and groups with matcher-based system This shifts notification routing into the matcher-system. Every notification has associated metadata (key-value fields, severity - to be extended) that can be match with match directives in notification matchers. Right now, there are 2 matching directives, match-field and match-severity. The first one allows one to do a regex match/exact match on a metadata field, the other one allows one to match one or more severites. Every matcher also allows 'target' directives, these decide which target(s) will be notified if a matcher matches a notification. Since routing now happens in matchers, the API for sending is simplified, since we do not need to specify a target any more. The API routes for filters and groups have been removed completely. The parser for the configuration file will still accept filter/group entries, but will delete them once the config is saved again. This is needed to allow a smooth transition from the old system to the new system, since the old system was already available on pvetest. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:13 +03:00
proxmox-serde.workspace = true
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
proxmox-schema = { workspace = true, features = ["api-macro", "api-types"]}
proxmox-section-config = { workspace = true }
notify: add sendmail plugin This plugin uses the 'sendmail' command to send an email to one or more recipients. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:34 +03:00
proxmox-sys = { workspace = true, optional = true }
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
proxmox-time.workspace = true
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
regex.workspace = true
notify: add sendmail plugin This plugin uses the 'sendmail' command to send an email to one or more recipients. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:34 +03:00
serde = { workspace = true, features = ["derive"]}
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
serde_json.workspace = true
notify: add sendmail plugin This plugin uses the 'sendmail' command to send an email to one or more recipients. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:34 +03:00
[features]
notify: add gotify endpoint Add an endpoint for Gotify [1], showing the how easy it is to add new endpoint implementations. [1] https://gotify.net/ Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:36 +03:00
default = ["sendmail", "gotify"]
notify: add mechanisms for email message forwarding As preparation for the integration of `proxmox-mail-foward` into the notification system, this commit makes a few changes that allow us to forward raw email messages (as passed from postfix). For mail-based notification targets, the email will be forwarded as-is, including all headers. The only thing that changes is the message envelope. For other notification targets, the mail is parsed using the `mail-parser` crate, which allows us to extract a subject and a body. As a body we use the plain-text version of the mail. If an email is HTML-only, the `mail-parser` crate will automatically attempt to transform the HTML into readable plain text. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:18 +03:00
mail-forwarder = ["dep:mail-parser"]
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
sendmail = ["dep:proxmox-sys"]
notify: add gotify endpoint Add an endpoint for Gotify [1], showing the how easy it is to add new endpoint implementations. [1] https://gotify.net/ Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:36 +03:00
gotify = ["dep:proxmox-http"]
Copy Permalink