VividCortex integrates directly with Slack and Grafana, allowing you to view any chart or metric outside of the VividCortex webapp.
VividCortex Slack App
VividCortex provides a Slack App which allows you to access VividCortex data within Slack, using slash commands. This includes the ability to choose the environment, hosts, and time frame, as well as set persistent options (context) to be used repeatedly with your slash commands.
To get started, find the VividCortex Slack App in the Slack App Directory (yourworkspace.slack.com/apps). Select Add to Slack. Install and authorize access.
Alternatively just click
to start installation immediately.
When completed you will see a success screen - the app is now ready to be used in any channel, and by any user, within your Slack team/workspace that you authorized.
Once you have installed the App, try this command:
/vividcortex chart os-cpu-utilization
You should see a chart of CPU utilization for all of your hosts in one of your environments. (If not, you’ll need to specify an environment; skip to the “Options” section, below.)
Now try the same thing, but for the past day:
/vividcortex using time from 1 day ago chart os-cpu-utilization
Let’s look at all of the options available. To get help and see a list of possible commands, type
The slash command has the following format:
/vividcortex [using options] chart <chart-or-metric-name>
The options are:
environment: Which environment to fetch data for. This is the environment’s unique name. Remember that spaces are not allowed in environment names.
[time] from: The beginning of the timeframe to fetch data. The
timekeyword is optional. You can use the following formats:
/vividcortex using time from 2019-08-29 08:00:00 /vividcortex using time from August 29, 2019 08:00:00 /vividcortex using time from 1 hour/day/week ago
[time] until: The end of the timeframe to fetch data. The
timekeyword is optional. The formats are the same as with
fromwith the additional option of
/vividcortex using time until now
hosts: A comma- or space-separated list of host names or host IDs.
/vividcortex using hosts db1, db2
Here’s an example of a command which uses every option:
/vividcortex using environment production hosts db1,db2 from 2019-08-29 08:00:00 until 2019-08-29 08:15:00 chart os-cpu-utilization
Charts are identified by their IDs. This may be slightly different than their default display title in VividCortex, but it’s the same ID you use when you edit a Dashboard. A list of chart IDs and their descriptions can be found in our documentation.
Persistent Options (Context)
When you don’t specify a value for one of the options (like in our first example without
time) it uses the value out of the current context. If you never set the context the App would use the default one. You can see the current context with
You can set aspects of your context so that you can run commands over and over without having to type the same option values again. To change the context, use
set instead of
using, and don’t provide a chart name:
/vividcortex set from 1 day ago until now
This will update your context and tell you the new context. Now when you run a command without
until, it will use the updated context.
One thing to note about
now: it sets the time to the current time, and will use that time over and over, so you can see a consistent view of data. It does not update the context as time passes.
VividCortex integrates directly with Grafana through our Grafana plugin. This allows you to view any of the thousands of metrics VividCortex collects in a dashboard you and your team are already using. For more information and to get started, check out our Grafana plugin GitHub repo.