[Docs/Reporting] Improve docs on automating Reporting #40931

tsullivan · 2019-07-11T23:31:47Z

Summary

Closes:

Missing documentation: Reporting generation URL now requires kbn-version header to be set #17941
Update "Automatic Report Generation" docs with CSV report info #37706
[Reporting] Documentation for Automating Report Generation has legacy example code contents #40661

Addresses:

[Phase 2] Usage of "Generation URL" should be made clear by UI #17920

Improve documentation on how to automate Kibana Reporting, with Watcher and with a custom script.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~[ ] This was checked for cross-browser compatibility, including a check against IE11~~
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
~~[ ] Documentation was added for features that require explanation or tutorials~~
~~[ ] Unit or functional tests were updated or added to match the most common scenarios~~
~~[ ] This was checked for keyboard-only and screenreader accessibility~~

Screenshot

tsullivan · 2019-07-11T23:34:15Z

docs/reporting/automating-report-generation.asciidoc

 include::report-intervals.asciidoc[]

-To get the URL for triggering a report generation during a given time period:
+[float]
+=== Getting the POST URL


Entirely new section to talk about what is the POST URL

tsullivan · 2019-07-11T23:34:46Z

docs/reporting/automating-report-generation.asciidoc


-To configure a watch to email reports, you use the `reporting` attachment type


Moved to watch-example

tsullivan · 2019-07-11T23:35:13Z

docs/reporting/automating-report-generation.asciidoc


+[float]


The lack of this [float] caused this section to be its own page, which seemed wrong

tsullivan · 2019-07-11T23:35:48Z

docs/reporting/watch-example.asciidoc

@@ -18,7 +25,7 @@ PUT _watcher/watch/error_report
        "attachments" : {
          "error_report.pdf" : {
            "reporting" : {
-              "url": "http://0.0.0.0:5601/api/reporting/generate/dashboard/Error-Monitoring?_g=(time:(from:now-1d%2Fd,mode:quick,to:now))", <2>
+              "url": "http://0.0.0.0:5601/api/reporting/generate/printablePdf?jobParams=...", <2>


tsullivan · 2019-07-11T23:36:34Z

docs/reporting/watch-example.asciidoc

 report from the Kibana UI.
 <3> Optional, default is 40
 <4> Optional, default is 15s
 <5> Provide user credentials for a user with permission to access Kibana and
 {reporting}.
 //For more information, see <<secure-reporting>>.
 //<<reporting-app-users, Setting up a Reporting Role>>.
+
+NOTE: Reporting is integrated with Watcher only as an email attachment type.


A new NOTE I felt it important to mention

tsullivan · 2019-07-11T23:37:02Z

docs/reporting/script-example.asciidoc

+
+If there was an error in generating the report, the download URL will return a 500
+(Internal Server Error) response. More information will be available in the the
+Reporting management page in Kibana: *Management > Kibana > Reporting*


Info about 503 was pre-existing. Info about the 500 is new

Wrapping this in IMPORTANT is also new

elasticmachine · 2019-07-12T00:31:50Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

docs/reporting/automating-report-generation.asciidoc

docs/reporting/script-example.asciidoc

gchaps · 2019-07-12T14:36:06Z

docs/reporting/automating-report-generation.asciidoc


+[float]
 == Deprecated Report URLs

 The following is deprecated in 6.0, and you should now use {kib} to get the URL for a


It's not clear "the following is deprecated" refers to.

What about:

The following POST URL paths were once supported but are now deprecated. If there are any problems with using these paths after upgrading Kibana's version, you should use {kib} to re-generate the POST URL for a particular report.

Yes, that's much better.

joelgriffith · 2019-07-12T15:41:35Z

This is awesome!

Co-Authored-By: gchaps <[email protected]>

elasticmachine · 2019-07-12T20:54:46Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

cjcenizal

The section regarding CSV reports looks terrific! I'm on support dev ramp this week so I don't have time to review the rest of the PR unfortunately. Thank you for doing this, Tim!

…g-post-url

… into docs/reporting-post-url

elasticmachine · 2019-07-15T18:45:11Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

tsullivan · 2019-07-15T19:52:17Z

I started making more changes about what can cause the 400 status. But since this PR has enough LGTMs, I then backed out those last changes. Going to merge this as it was when it got the LGTM.

* [Docs/Reporting] Improve docs on automating Reporting * Update docs/reporting/automating-report-generation.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * --wip-- [skip ci] * word change

elasticmachine · 2019-07-15T20:59:26Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

tsullivan · 2019-07-15T21:55:51Z

@lcawl You let me know that you added a followup fix to master. As you requested, I cherry picked it into each of the backport branches:

7.x/7.4: #41179
7.3: #41180
7.2: #41181

…41179) * [Docs/Reporting] Improve docs on automating Reporting (#40931) * [Docs/Reporting] Improve docs on automating Reporting * Update docs/reporting/automating-report-generation.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * --wip-- [skip ci] * word change * [DOCS] Fixes broken reporting links (#41195)

…41180) * [Docs/Reporting] Improve docs on automating Reporting (#40931) * [Docs/Reporting] Improve docs on automating Reporting * Update docs/reporting/automating-report-generation.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * --wip-- [skip ci] * word change * [DOCS] Fixes broken reporting links (#41195)

…41181) * [Docs/Reporting] Improve docs on automating Reporting (#40931) * [Docs/Reporting] Improve docs on automating Reporting * Update docs/reporting/automating-report-generation.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/reporting/script-example.asciidoc Co-Authored-By: gchaps <[email protected]> * --wip-- [skip ci] * word change * [DOCS] Fixes broken reporting links (#41195)

lcawl · 2019-07-15T21:59:33Z

Thanks @tsullivan !

renshuki · 2020-03-03T06:51:15Z

@tsullivan @lcawl does it make sense to backport this to 6.8 as well with minor changes (like kbn-version header)? I don't see anything feature specific to 7.x and I think this is expecting to work on 6.8.

[Docs/Reporting] Improve docs on automating Reporting

6fe98c8

tsullivan added v7.2.0 v7.3.0 v7.4.0 v8.0.0 (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead review labels Jul 11, 2019

tsullivan assigned joelgriffith, gchaps and cjcenizal Jul 11, 2019

tsullivan commented Jul 11, 2019

View reviewed changes

tsullivan requested review from gchaps, cjcenizal and joelgriffith July 12, 2019 00:30

tsullivan unassigned cjcenizal, joelgriffith and gchaps Jul 12, 2019

gchaps reviewed Jul 12, 2019

View reviewed changes

joelgriffith approved these changes Jul 12, 2019

View reviewed changes

tsullivan and others added 3 commits July 12, 2019 12:34

Update docs/reporting/automating-report-generation.asciidoc

53617aa

Co-Authored-By: gchaps <[email protected]>

Update docs/reporting/script-example.asciidoc

fb8f579

Co-Authored-By: gchaps <[email protected]>

Update docs/reporting/script-example.asciidoc

fcaace1

Co-Authored-By: gchaps <[email protected]>

tsullivan added the release_note:skip Skip the PR/issue when compiling release notes label Jul 12, 2019

--wip-- [skip ci]

c28b979

cjcenizal approved these changes Jul 15, 2019

View reviewed changes

tsullivan added 2 commits July 15, 2019 10:37

Merge branch 'master' of github.com:elastic/kibana into docs/reportin…

a989217

…g-post-url

Merge branch 'docs/reporting-post-url' of github.com:tsullivan/kibana…

8b0f562

… into docs/reporting-post-url

word change

6dced7c

tsullivan force-pushed the docs/reporting-post-url branch from ba6b15c to 6dced7c Compare July 15, 2019 19:51

tsullivan merged commit e24440e into elastic:master Jul 15, 2019

tsullivan deleted the docs/reporting-post-url branch July 15, 2019 19:53

tsullivan mentioned this pull request Jul 15, 2019

[7.3] [Docs/Reporting] Improve docs on automating Reporting (#40931) #41180

Merged

tsullivan mentioned this pull request Jul 15, 2019

[7.2] [Docs/Reporting] Improve docs on automating Reporting (#40931) #41181

Merged

lcawl mentioned this pull request Jul 15, 2019

[DOCS] Fixes broken reporting links #41195

Merged

3 tasks

tsullivan mentioned this pull request Jul 15, 2019

[Docs/Reporting] More information about HTTP / script stuff #41200

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs/Reporting] Improve docs on automating Reporting #40931

[Docs/Reporting] Improve docs on automating Reporting #40931

tsullivan commented Jul 11, 2019 •

edited

Loading

tsullivan Jul 11, 2019

tsullivan Jul 11, 2019

tsullivan Jul 11, 2019

tsullivan Jul 11, 2019

tsullivan Jul 11, 2019

tsullivan Jul 11, 2019 •

edited

Loading

elasticmachine commented Jul 12, 2019

gchaps Jul 12, 2019

tsullivan Jul 12, 2019 •

edited

Loading

gchaps Jul 12, 2019

joelgriffith commented Jul 12, 2019

elasticmachine commented Jul 12, 2019

cjcenizal left a comment

elasticmachine commented Jul 15, 2019

tsullivan commented Jul 15, 2019

elasticmachine commented Jul 15, 2019

tsullivan commented Jul 15, 2019

lcawl commented Jul 15, 2019

renshuki commented Mar 3, 2020


		To configure a watch to email reports, you use the `reporting` attachment type


		[float]

[Docs/Reporting] Improve docs on automating Reporting #40931

[Docs/Reporting] Improve docs on automating Reporting #40931

Conversation

tsullivan commented Jul 11, 2019 • edited Loading

Summary

Checklist

Screenshot

tsullivan Jul 11, 2019

Choose a reason for hiding this comment

tsullivan Jul 11, 2019

Choose a reason for hiding this comment

tsullivan Jul 11, 2019

Choose a reason for hiding this comment

tsullivan Jul 11, 2019

Choose a reason for hiding this comment

tsullivan Jul 11, 2019

Choose a reason for hiding this comment

tsullivan Jul 11, 2019 • edited Loading

Choose a reason for hiding this comment

elasticmachine commented Jul 12, 2019

💔 Build Failed

gchaps Jul 12, 2019

Choose a reason for hiding this comment

tsullivan Jul 12, 2019 • edited Loading

Choose a reason for hiding this comment

gchaps Jul 12, 2019

Choose a reason for hiding this comment

joelgriffith commented Jul 12, 2019

elasticmachine commented Jul 12, 2019

💔 Build Failed

cjcenizal left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 15, 2019

💚 Build Succeeded

tsullivan commented Jul 15, 2019

elasticmachine commented Jul 15, 2019

💚 Build Succeeded

tsullivan commented Jul 15, 2019

lcawl commented Jul 15, 2019

renshuki commented Mar 3, 2020

tsullivan commented Jul 11, 2019 •

edited

Loading

tsullivan Jul 11, 2019 •

edited

Loading

tsullivan Jul 12, 2019 •

edited

Loading