All source plugins have a system wide and an widget specific configuration.
System wide configuration can be found in RAILS_ROOT/config/application.rb
and can set via environment variables for Rails:
GRAPHITE_URL=http://localhost:8080 rails s
The widget specific configuration is done when creating widgets in the Rails app.
All widgets have the same set of required parameters in common:
- name
- kind (Widget type, for example: "number", "boolean", "graph", etc.)
- source (Source Plugin, for example: "demo", "sensu")
- update_interval
- dashboard_id
Additionally, all source plugins can specify additional parameters which are listed below for each source plugin grouped by widget.
The source plugins reside in RAILS_ROOT/app/models/sources, grouped by widget.
- sensu_events (SENSU_EVENTS_URL)
- sensu_clients (optional)
- ignored_checks (optional)
No configuration required.
- http_proxy_path (mandatory)
{
"value": true,
"label": "Hello World"
}
- uptime_url (UPTIME_URL)
- check_name (mandatory)
No configuration required.
- user (mandatory)
- password (mandatory)
- key (mandatory)
- check (mandatory)
No configuration required.
- command (mandatory)
No configuration required.
- server_url (mandatory)
- project (mandatory)
No configuration required.
- server_url (mandatory)
- project (mandatory)
- ganglia_web_url (GANGLIA_WEB_URL)
- ganglia_host (GANGLIA_HOST)
- targets (mandatory)
- graphite_url (GRAPHITE_URL)
- targets (mandatory)
No configuration required.
- http_proxy_path (mandatory)
- targets (mandatory)
[
{
"target": "First target",
"datapoints": [[1, 2], [2, 3], [4, 6]]
},
{
"target": "Second target",
"datapoints": [[1, 2], [2, 3], [4, 6]]
}
]
- graphite_url (GRAPHITE_URL)
- targets (mandatory)
No configuration required.
- server_url (mandatory)
- api_key (mandatory)
No configuration required.
- app_identifier (mandatory)
- app_token (mandatory)
No configuration required.
- url (mandatory)
- user_name (mandatory)
- jira_url (JIRA_URL)
- jira_user (JIRA_USER)
- jira_password (JIRA_PASSWORD)
- filter_id
Create a Search Filter in your Jira installation and remember the Filter ID (requestId
in URL when viewing the filter)
No configuration required.
- api_key (mandatory)
- value_name (mandatory)
No configuration required.
- user (mandatory)
- password (mandatory)
- key (mandatory)
- check (mandatory)
No configuration required.
- http_proxy_path (mandatory)
[
{
"label": "Curabitur condimentum leo",
"value": "2013/03/11",
"status": 2
},
{
"label": "Lorem ipsum dolor sit amet",
"value": "2013/05/15",
"status": 2
}
]
No configuration required.
- input_file (mandatory)
[
{
"label": "Curabitur condimentum leo",
"value": "2013/03/11",
"status": 2
},
{
"label": "Lorem ipsum dolor sit amet",
"value": "2013/05/15",
"status": 2
}
]