Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add event overlays #29

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

cory-stripe
Copy link

@cory-stripe cory-stripe commented Apr 4, 2018

Summary

Adds support for event overlays (and selected event overlays) to dashboards

Motivation

Specifying common event overlays (deploys, etc) in terraform definitions is very useful.

It looks like this:

selected_event_overlay {
    line = true
    label = "Deploy events"
    color = "emerald"
    signal = "deploy"

    source {
      property = "host_env"
      values = ["prod"]
    }

    source {
      property = "service"
      values = ["veneur-proxy-srv"]
    }
  }

Notes

  • Selected overlays and normal overlays are a bit weird. To make an event overlay that is also "selected" requires you to enter it as both an eventOverlay and a selectedEventOverlay. It might be better to just put a flag in here and do that for them. I'd love some philosophic guidance on that.
  • I don't think there's any testing possible here that isn't actively hitting the API, but it works for me? :)
  • I chose to pluralization using filter as a guide
  • I validated the color using the existing mechanisms
  • This includes some logging from Add logging of dashboard create and update payloads #28 cuz it was SUPER helpful, hoping I can remove that in a rebase
  • I assume I should add docs, unsure how it works at a glance…

Thanks and let me know how I can improve this!

@cory-stripe cory-stripe changed the title WIP Add event overlays Add event overlays Apr 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant