[dogshell] Enforce the default 'normal' event priority client side#511
Merged
[dogshell] Enforce the default 'normal' event priority client side#511
Conversation
The CLI help output stats that the default `priority` value used when
posting an event with `dog event post` is `normal`. That value isn't
enforced on the client side, and it seems leaving it to `None` has an
unexpected side effect: the API returns an HTTP 200 response along with
an link to the indexed event, which always returns an HTTP 404.
Example:
```console
$ dog --raw event post --alert_type 'info' --no_host 'test by balthazar' 'checking for any pebcak' | jq .
{
"status": "ok",
"event": {
"id": XXXX,
"title": "test by balthazar",
"text": "checking for any pebcak",
"date_happened": 1578645516,
"handle": null,
"priority": null,
"related_event_id": null,
"tags": [],
"url": "https://app.datadoghq.com/event/event?id=1234"
}
}
```
That event url always returns an HTTP 404 when opened. We can see
`"priority": null` in the response payload.
If we however explicitly set the `--priority` flag to `normal` in the
command-line, we can see `"priority": "normal"` in the JSON output:
```console
$ dog --raw event post --priority normal --alert_type 'info' --no_host 'test by balthazar' 'checking for any pebcak' | jq .
{
"status": "ok",
"event": {
"id": YYYYY,
"title": "test by balthazar",
"text": "checking for any pebcak",
"date_happened": 1578645659,
"handle": null,
"priority": "normal",
"related_event_id": null,
"tags": [],
"url": "https://app.datadoghq.com/event/event?id=ABCD"
}
}
```
Visiting the event URL now returns an HTTP 200, and I can find the event
by searching in the event stream.
Additional API validation will of course have to be added server-side
but this is at least a start.
behos
approved these changes
Jan 10, 2020
gzussa
approved these changes
Jan 10, 2020
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requirements for Contributing to this repository
What does this PR do?
Enforce the default event priority value to
normalwhen submitting an event via the API.Description of the Change
The CLI help output stats that the default
priorityvalue used whenposting an event with
dog event postisnormal. That value isn'tenforced on the client side, and it seems leaving it to
Nonehas anunexpected side effect: the API returns an HTTP 200 response along with
an link to the indexed event, which always returns an HTTP 404.
Example:
That event url always returns an HTTP 404 when opened. We can see
"priority": nullin the response payload.If we however explicitly set the
--priorityflag tonormalin thecommand-line, we can see
"priority": "normal"in the JSON output:Visiting the event URL now returns an HTTP 200, and I can find the event
by searching in the event stream.
Additional API validation will of course have to be added server-side
but this is at least a start.
Alternate Designs
Possible Drawbacks
Verification Process
Additional Notes
Release Notes
Review checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.