stable
Getting started
Installation
Configuration file
Examples
About this tool
Plugins
Google Analytics
Jenkins
MySQL
Plot
Prometheus
S3
SCP (secure copy)
SendGrid
Slack
SMTP
Static file
Table
Twitter
Development
Architecture
Plugins
KPI Reporter API
kpireport
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
X
A
access_token_key (kpireport_twitter.TwitterDatasource attribute)
access_token_secret (kpireport_twitter.TwitterDatasource attribute)
add_format() (kpireport.report.Content method)
api_key (kpireport_sendgrid.SendGridOutputDriver attribute)
api_token (kpireport_jenkins.datasource.JenkinsDatasource attribute)
(kpireport_slack.SlackOutputDriver attribute)
B
bar_labels (kpireport_plot.Plot attribute)
basic_auth (kpireport_prometheus.PrometheusDatasource attribute)
bucket (kpireport_s3.S3OutputDriver attribute)
C
can_render() (kpireport.output.OutputDriver method)
channels (kpireport_slack.SlackOutputDriver attribute)
column_width (kpireport.report.Theme attribute)
comparison_query (kpireport_plot.SingleStat attribute)
comparison_type (kpireport_plot.SingleStat attribute)
config (kpireport.report.ReportFactory attribute)
consumer_key (kpireport_twitter.TwitterDatasource attribute)
consumer_secret (kpireport_twitter.TwitterDatasource attribute)
Content (class in kpireport.report)
create() (kpireport.report.ReportFactory method)
D
Datasource (class in kpireport.datasource)
datasource (kpireport_plot.Plot attribute)
(kpireport_plot.SingleStat attribute)
(kpireport_prometheus.PrometheusAlertSummary attribute)
(kpireport_table.Table attribute)
DatasourceError
E
email_from (kpireport_sendgrid.SendGridOutputDriver attribute)
(kpireport_smtp.SMTPOutputDriver attribute)
email_to (kpireport_sendgrid.SendGridOutputDriver attribute)
(kpireport_smtp.SMTPOutputDriver attribute)
end_date (kpireport.report.Report attribute)
error_colors (kpireport.report.Theme attribute)
F
filter_job() (kpireport_jenkins.build_summary.JenkinsBuildFilter method)
formats (kpireport.report.Content attribute)
G
get_all_jobs() (kpireport_jenkins.datasource.JenkinsDatasource method)
get_format() (kpireport.report.Content method)
get_job_info() (kpireport_jenkins.datasource.JenkinsDatasource method)
get_views() (kpireport.report.Content method)
GoogleAnalyticsDatasource (class in kpireport_googleanalytics.datasource)
groupby (kpireport_plot.Plot attribute)
H
heading_font (kpireport.report.Theme attribute)
hide_labels (kpireport_prometheus.PrometheusAlertSummary attribute)
host (kpireport_jenkins.datasource.JenkinsDatasource attribute)
(kpireport_prometheus.PrometheusDatasource attribute)
I
id (kpireport.output.OutputDriver attribute)
ignore_labels (kpireport_prometheus.PrometheusAlertSummary attribute)
image_remote_base_url (kpireport_slack.SlackOutputDriver attribute)
(kpireport_smtp.SMTPOutputDriver attribute)
image_strategy (kpireport_smtp.SMTPOutputDriver attribute)
init() (kpireport.datasource.Datasource method)
(kpireport.output.OutputDriver method)
interval_days (kpireport.report.Report attribute)
J
j2 (kpireport.report.Content attribute)
JenkinsBuildFilter (class in kpireport_jenkins.build_summary)
JenkinsBuildSummary (class in kpireport_jenkins.build_summary)
JenkinsDatasource (class in kpireport_jenkins.datasource)
K
key_file (kpireport_googleanalytics.datasource.GoogleAnalyticsDatasource attribute)
kind (kpireport_plot.Plot attribute)
kpireport.datasource
module
kpireport.output
module
kpireport.report
module
kpireport.view
module
kwargs (kpireport_mysql.datasource.MySQLDatasource attribute)
(kpireport_s3.S3OutputDriver attribute)
L
label (kpireport_plot.SingleStat attribute)
labels (kpireport_prometheus.PrometheusAlertSummary attribute)
link_url (kpireport_plot.SingleStat attribute)
M
max_rows (kpireport_table.Table attribute)
module
kpireport.datasource
kpireport.output
kpireport.report
kpireport.view
MySQLDatasource (class in kpireport_mysql.datasource)
N
num_columns (kpireport.report.Theme attribute)
O
output_dir (kpireport_static.StaticOutputDriver attribute)
output_format (kpireport_static.StaticOutputDriver attribute)
OutputDriver (class in kpireport.output)
OutputDriverError
P
padding_width (kpireport.report.Theme attribute)
pagination_delay_s (kpireport_twitter.TwitterDatasource attribute)
Plot (class in kpireport_plot)
plot_rc (kpireport_plot.Plot attribute)
post_plot() (kpireport_plot.Plot method)
prefix (kpireport_s3.S3OutputDriver attribute)
PrometheusAlertSummary (class in kpireport_prometheus)
PrometheusDatasource (class in kpireport_prometheus)
Q
query (kpireport_plot.Plot attribute)
(kpireport_plot.SingleStat attribute)
(kpireport_table.Table attribute)
query() (kpireport.datasource.Datasource method)
(kpireport_googleanalytics.datasource.GoogleAnalyticsDatasource method)
(kpireport_jenkins.datasource.JenkinsDatasource method)
(kpireport_mysql.datasource.MySQLDatasource method)
(kpireport_prometheus.PrometheusDatasource method)
(kpireport_twitter.TwitterDatasource method)
query_args (kpireport_plot.Plot attribute)
(kpireport_table.Table attribute)
query_report() (kpireport_googleanalytics.datasource.GoogleAnalyticsDatasource method)
R
render_blob_inline() (kpireport.output.OutputDriver method)
render_output() (kpireport.output.OutputDriver method)
Report (class in kpireport.report)
report (kpireport.output.OutputDriver attribute)
(kpireport.report.Content attribute)
ReportFactory (class in kpireport.report)
resolution (kpireport_prometheus.PrometheusAlertSummary attribute)
S
S3OutputDriver (class in kpireport_s3)
SCPOutputDriver (class in kpireport_scp)
SendGridOutputDriver (class in kpireport_sendgrid)
series_colors (kpireport.report.Theme attribute)
show_timeline (kpireport_prometheus.PrometheusAlertSummary attribute)
SingleStat (class in kpireport_plot)
SlackOutputDriver (class in kpireport_slack)
smtp_host (kpireport_smtp.SMTPOutputDriver attribute)
smtp_port (kpireport_smtp.SMTPOutputDriver attribute)
SMTPOutputDriver (class in kpireport_smtp)
stacked (kpireport_plot.Plot attribute)
start_date (kpireport.report.Report attribute)
StaticOutputDriver (class in kpireport_static)
success_colors (kpireport.report.Theme attribute)
supported_formats (kpireport.output.OutputDriver attribute)
(kpireport.report.ReportFactory attribute)
T
Table (class in kpireport_table)
Theme (class in kpireport.report)
theme (kpireport.report.Report attribute)
theme_dir (kpireport.report.Theme attribute)
time_column (kpireport_plot.Plot attribute)
timeline_height (kpireport_prometheus.PrometheusAlertSummary attribute)
timezone (kpireport.report.Report attribute)
title (kpireport.report.Report attribute)
TwitterDatasource (class in kpireport_twitter)
TwitterEngagement (class in kpireport_twitter)
U
ui_colors (kpireport.report.Theme attribute)
user (kpireport_jenkins.datasource.JenkinsDatasource attribute)
V
View (class in kpireport.view)
ViewException
X
xtick_rotation (kpireport_plot.Plot attribute)
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.