Commit graph

60 commits

Author SHA1 Message Date
Anton Dosov
2ea91b14e7
[Docs] Clarifying CSV limitations (#175208)
## Summary 

Adding CSV limitations section
2024-01-25 11:04:15 -05:00
amyjtechwriter
0b0110a2dd
[DOCS] Linking reporting and sharing page with configure reporting page (#171977)
## Summary

Linking the "[Reporting and
Sharing](https://www.elastic.co/guide/en/kibana/current/reporting-settings-kb.html#reporting-advanced-settings)"
and the "[Configure
reporting](https://www.elastic.co/guide/en/kibana/current/secure-reporting.html)"
documentation pages to each other as they contain information that
relate to each page. Also contains a small formatting fix to a NOTE on
the Configure reporting page.

Closes: #169065
2023-11-28 11:08:01 +00:00
Lisa Cawley
668968b758
[DOCS] Replace description attributes with frontmatter for migration (#158126) 2023-05-24 08:16:43 -07:00
Kaarina Tungseth
06a800fbad
[DOCS] Adds 8.8 Viz docs (#157215)
## Summary

Adds the 8.8 documentation for the following:

- Enable report sharing: https://github.com/elastic/kibana/pull/153429
Docs preview:
https://kibana_157215.docs-preview.app.elstc.co/guide/en/kibana/master/reporting-getting-started.html

- Random sampling feature: https://github.com/elastic/kibana/pull/143221
Docs preview:
https://kibana_157215.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#improve-visualization-loading-time

- Improve Ignore global filters UI:
https://github.com/elastic/kibana/pull/154441 and
https://github.com/elastic/kibana/pull/155280
Docs preview:
https://kibana_157215.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#add-annotations

---------

Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>
2023-05-23 10:41:42 -05:00
Kaarina Tungseth
3de0009dd1
[DOCS] Adds Visualizations features for 8.7 (#151045)
## Summary

Adds the 8.7 docs for:

- #149388
- #148829
- Closes #144590
- Replaces #144551
2023-03-01 14:28:19 -06:00
Jeramy Soucy
aab8cf1302
[DOCS] Update 'xpack.screenshotting.browser.chromium.disableSandbox` documentation (#148425)
- Adds CentOS to the list of exceptions to the default value. CentOS,
Debian, and Red Hat Linux use `true`, but all other OS use `false`.
Previously, CentOS was not documented.

- Adds note regarding Chrome crash in the troubleshooting doc.
2023-01-10 09:26:57 -05:00
Nick Peihl
27483d5aa9
Fix curl documentation (#141971) 2022-09-27 17:18:41 -04:00
DeDe Morton
bbfe3e725e
Update automating-report-generation.asciidoc (#134410) 2022-06-15 13:01:14 -07:00
Tim Sullivan
1c08fb4cfb
improve text on reporting setup and dependencies (#134406) 2022-06-15 09:21:30 -07:00
Jean-Louis Leysens
cc6057f988
update copy per feedback from kellyemurphy (#130587) 2022-04-20 10:49:52 +02:00
Jean-Louis Leysens
baad4d65f6
[Reporting/Docs] User guidance to enable reporting on Cloud (memory constraints) (#129989)
* added callout about reporting on cloud

* slight rewording

* v2
2022-04-14 10:21:49 -07:00
Tim Sullivan
719ccb6d87
[Reporting] Document steps to grant users reporting access under Basic (#127513)
* [Reporting] Document steps to grant users reporting access under Basic license

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* corrections to api calls

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-03-14 10:50:40 -07:00
Tim Sullivan
1095208ace
[Reporting/Docs] Add clarity to reporting concepts (#125175)
* discourage setting enabled:false

* mark xpack.reporting.kibanaServer as experimental

* move kibanaServer section down

* add kibana privileges with reporting options screenshot

* rephrase why reporting.roles is depreccated

* screenshot for how to define a custom role the grants reporting privileges

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/settings/reporting-settings.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/settings/reporting-settings.asciidoc

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-02-11 09:40:41 -07:00
Tim Sullivan
4ba843c267
[Screenshotting] Darwin downloads Chromium at startup, add ARM support for Darwin (#122057)
* update puppeteer

* [Reporting] Use downloadable chromium build for the Mac OS headless browser

* fix test

* [Screenshotting] add new paths for mac browsers

* add bundled field to chromium download paths interface

* update build scripts

* polish

* log when skip

* stop downloading all packages every time

* pass the PackageInfo object to the install function

* remove eslint-disable-line

* fix call to getBinaryPath

* polish

* simplify plugin.ts

* fix unit test

* fix lint

* tweak gulp task to explicitly download chromium for all platforms

* ignore chromium when copying x-pack source

* simplify

* update documentation with steps to manually download chromium

* Apply Documentation suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* update docs to cut redundancy

* clean up link to manual browser download

* wording choice adjustment

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2022-01-05 21:44:29 -07:00
Kaarina Tungseth
7e8b5f9eeb
Remove CentOS (#121128) 2021-12-14 15:06:05 -06:00
Kaarina Tungseth
fdc0ce749a
[DOCS] Indicate reports are a subscription feature (#114653) 2021-10-13 09:59:50 -05:00
Jean-Louis Leysens
46e0f0ba3e
[Reporting] Added docs about the new ILM kibana-reporting policy (#108018)
* first iteration of ilm policy copy - in a callout

* apply James' suggested change

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-08-11 12:43:13 +02:00
Kaarina Tungseth
25585947ea
[DOCS] Updates the screenshots for Reporting and sharing (#106435)
* [DOCS] Updates the Reporting and sharing images for 7.14

* [DOCS] Updates the screenshots for Reporting and sharing

* Adds links to anon access and reporting settings
2021-07-26 10:55:26 -05:00
Kaarina Tungseth
524fe6dfe2
[DOCS] Updates to the Reporting docs (#101326)
* [DOCS] Updates to thee Reporting docs

* Adds the main sharing page

* Final changes

* Changed configuring-reporting link to secure-reporting

* Updates from meeting with Tim and Larry

* Moves reporting and sharing content above ML

* Update docs/setup/configuring-reporting.asciidoc

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Review comments from Tim and Larry

* Fixes broken links

* Fixes redirect

* Fixes broken link from ES docs

* Adds metadata to changed pages

* Review comments

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
2021-06-30 12:10:04 -05:00
Tim Sullivan
a816dae162
[Reporting/Docs] Add section to troubleshooting guide to explain the StatusCodeError logs (#102278)
* [Reporting/Docs] Add section to troubleshooting guide to explain the StatusCodeError logs

* Update docs/user/reporting/reporting-troubleshooting.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* use script formatting around error message block

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-06-16 13:55:53 -07:00
Nathan Reese
bb4b186811
Update reporting troubleshooting docs with section about Elastic Maps Service (#99780)
* Update reporting troubleshooting docs with section about Elastic Maps Service

* Update docs/user/reporting/reporting-troubleshooting.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/user/reporting/reporting-troubleshooting.asciidoc

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

* review feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2021-05-12 15:20:47 -06:00
Tim Sullivan
1ce0cf6f5d
Reporting/Docs: update version of reporting_user deprecation (#98988) 2021-05-03 10:35:12 -07:00
Tim Sullivan
5a6eda2b22
[Reporting] Kibana Application Privileges for Reporting (#94966)
* Implement Reporting features as subfeatures of applications

* add setting to the docker list

* update doc images

* finish docs

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* typo fix

* "PDF / PNG Reports" => "Reporting"

* Update x-pack/plugins/reporting/server/config/index.ts

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/test/functional/apps/security/secure_roles_perm.js

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* update ids of report privileges

* combine dashboard privileges into 1 group

* update jest snapshot

* fix tests

* fix tests

* updates from feedback

* add note

* update screenshot

* fix grammer

* fix bad link breaks in doc

* update doc heading

* Apply suggestions documentation feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* simplify

* use const assertions

* Apply text change suggestion from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* more test for oss_features and reporting subFeatures

* reduce loc diff

* fix snapshot

* fix flakiness in licensing plugin public functional tests

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-04-20 20:44:24 -07:00
Christiane (Tina) Heiligers
d29abdfa15
[DOCS] Adds user-facing docs for the new KP logging configuration (#94993)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2021-03-30 07:54:15 -07:00
Tim Sullivan
9fef424bba
Switch Reporting to Task Manager (#64853)
* [Reporting] Task Manager

* fix startup

* use synchronous config for task registration

* fix eslint

* pr-90365

* --wip-- [skip ci]

* set maxConcurrency to 0 if pollEnabled is false

* add test for execute_report

* remove unused test file

* more tests

* remove unused test files

* remove priority

* logging cleanups

* fix for queue.pollEnabled: false

* more logging fixes for less duplicated code

* update jest snapshots

* polish

* remove unnecessary

* Update mapping.ts

* polish

* fix bug if instance gets a monitoring task and pollEnabled is false

* simplification

* cosmetic

* fix test

* stop monitoring task sabotage

* update api docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-08 17:33:19 -07:00
Kaarina Tungseth
d5e4a2ae7d
[DOCS] Changes Visualize to Visualize Library (#93055)
* [DOCS] Changes Visualize to Visualize Library

* Review comments

* Review comment

* Removes background in embed-kibana.png
2021-03-08 13:44:30 -06:00
Kaarina Tungseth
e980ee4740
[DOCS] Updates reporting and Canvas share options (#92529)
* [DOCS] Updates reporting and Canvas share options

* Update docs/canvas/canvas-share-workpad.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Resizes images and minor text edits

* Updates dashboard embed content

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-02-24 09:54:28 -06:00
liza-mae
befe41067e
[Docs] Update reporting troubleshooting for arm rhel/centos (#90385)
* Update reporting document

* Move to own section

* Remove extra line
2021-02-05 15:06:15 -07:00
Joe Portner
1927556729
Update reporting docs (#87651) 2021-01-11 14:52:54 -05:00
Poff Poffenberger
d28ae4291a
[Docs] Update Canvas reporting docs for new full page layout feature (#86124)
* Update Canvas and reporting doc for new full page layout

* Typo
2020-12-17 15:05:30 -06:00
Kaarina Tungseth
57b7702314
[DOCS] Reallocates limitations to point-of-use (#79582)
* [DOCS] Reallocates limitations to point-of-use

* KQL changes

* Removed limitations file

* Review comments
2020-11-19 10:49:27 -06:00
Kaarina Tungseth
c77619352b
[DOCS] 7.10 Core UI changes (#80407)
* [DOCS] 7.10 screenCore UI changes

* Kibana access options

* Removed Kibana from Set up Kibana

* Removed rogue symbols

* Update docs/spaces/index.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/management/managing-beats.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Update docs/user/introduction.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Changed menu to main menu

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-10-22 09:06:51 -05:00
Tim Sullivan
c3b1b17916
[Reporting] Document Network Policy configuration (#80431)
* [Reporting] Document Network Policy configuration

* Apply suggestions from code review

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* remove detail about policy acting on responses

* Update docs/user/reporting/network-policy.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* lowercase network policy

* typo

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-10-16 10:43:17 -07:00
gchaps
dffd631217
[DOCS] Edits copy in Reporting Diagnostics tool (#77833)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-09-29 09:12:13 -07:00
Joel Griffith
9edb8d9ae2
Reporting/diagnostics (#74314)
* WIP: Adding in new reporting diag tool

* WIP: chrome-binary test + log capturing/error handling

* More wip on diagnostic tool

* More work adding in diagnose routes

* Alter link in description + minor rename of chrome => browser

* Wiring UI to API + some polish on UI flow

* WIP: Add in screenshot diag route

* Adding in screenshot diag route, hooking up client to it

* Add missing lib check + memory check

* Working screenshot test + config check for RAM

* Small test helper consolidation + screenshot diag test

* Delete old i18n translations

* PR feedback, browser tests, rename, re-organize import statements and lite fixes

* Lite rename for consistency

* Remove old validate check i18n

* Add config check

* i18n all the things!

* Docs on diagnostics tool

* Fixes, better readability, spelling and more for diagnostic tool

* Translate a few error messages

* Rename of test => start_logs for clarity. Move to observables

* Gathering logs even during process exit or crash

* Adds a test case for the browser exiting during the diag check

* Tap into browser logs for checking output

* Rename asciidoc diag id

* Remove duplicate shared object message

* Add better comment as to why we merge events + wait for a period of time

* Cloning logger for mirroring browser stderr to kibana output

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-09-09 16:11:23 -07:00
Kaarina Tungseth
c84532aade
[DOCS] Dashboard-first docs refresh (#76194)
* [DOCS] Dashboard-first refresh

* Fixes broken links and partinto error

* Fixes images in panel table

* Fixes broken links

* Fixes broken drilldowns link

* Fixes images and table

* Removed un needed files and added edit content

* Update docs/getting-started/tutorial-visualizing.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Review comments

* Removed blocks

* Typo fix

* Update docs/getting-started/tutorial-sample-data.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-discovering.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-sample-data.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/getting-started/tutorial-visualizing.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/edit-dashboards.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/dashboard.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/dashboard.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/aggregation-reference.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Review comments

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
2020-09-03 16:34:25 -05:00
Toby Sutor
56609049cb
32 characters requirement for xpack.reporting.encryptionKey (#72594)
Similar to https://github.com/elastic/kibana/pull/72593 document that the string needs to be at least 32 characters long.
2020-07-28 09:35:08 -05:00
gchaps
10846cb361
[DOCS] Updates Management docs to match UI (#72514)
* [DOCS] Updates Management docs to match UI

* [DOCS] Incorporates review comments

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-07-22 08:00:53 -07:00
Lisa Cawley
7aa600bff7
[DOCS] Removes occurrences of X-Pack Security and Reporting (#72302) 2020-07-17 14:53:04 -07:00
Tyler Smalley
afe785b43a
[build] Creates Linux aarch64 archive (#69165)
- Updates Linux Chromium builds to accept architecture argument (defaults to x64) for arm64 support.
  - Example: `python ~/chromium/build_chromium/build.py 312d84c8ce62810976feda0d3457108a6dfff9e6 arm64`
- Updates all Chromium builds to include architecture in filename. 
  - `chromium-312d84c-linux_arm64.zip` _(new)_
  - `chromium-312d84c-linux.zip` > `chromium-312d84c-linux_x64.zip`
- Moves Chromium install from data directory to `x-pack/plugins/reporting/chromium`
- Moves Chromium download cache from `x-pack/plugins/reporting/.chromium` to `.chromium`
- Installs Chromium during build (closes #53664)
- Updates build to be architecture aware (x64 and aarch64)
- Removed Chromium debug logs, they were not helpful and can not be written inside the Kibana root. If we were to keep them, we would need to write to `logging.dist`.

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2020-07-09 19:42:48 -07:00
Kaarina Tungseth
a5bbbf96b5
[DOCS] Image cleanup (#71258)
* [DOCS] Image clean up

* Second half of images folder

* Fixes errors
2020-07-09 10:38:50 -05:00
Kaarina Tungseth
1225c32fac
[DOCS] Reorganizes doc nav to match new Kibana nav (#69069) 2020-06-12 16:09:44 -05:00
Kaarina Tungseth
896b9cddbc
[DOCS] Updates for navigation redesign (#68709)
* [DOCS] Updates for navigation redesign

* Getting started

* Set up text

* Discover

* Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools

* Dev Tools, Stack Monitoring, Management

* Management

* Final changes

* [DOCS] Updates for navigation redesign

* [DOCS] Updates CCR monitoring screenshots

* updates SIEM screenshot and Cases overview text

* Added Brandon's APM image

* [DOCS] Refines CCR shard screenshot

* Removed merge conflict image file

Co-authored-by: lcawl <lcawley@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>
2020-06-12 09:39:36 -05:00
Poff Poffenberger
6c1f5ec81b
[Canvas] Reduce report generation time by re-using headless browser page in background (#63301)
* Rough first pass at reusing page for multiple links in report generation

* Some adjustments to handling the events coming from CDP

* Add new data-share-page selector for jobs with multiple urls

* Cleanup

* PR feedback

* Adding tests for Canvas export app and multi user observable jobs

* Adding a short blurb describing the data-shared-page attribute requirement

* PR feedback

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-05-04 13:55:13 -05:00
Kaarina Tungseth
74a07b46d8
[DOCS] Added images to automating report generation (#64333)
* [DOCS] Added images to automating report generation

* Fixes image file name
2020-04-23 15:00:40 -05:00
Tim Sullivan
f4c81b440d
[Reporting] Switch Serverside Config Wrapper to NP (#62500)
* New config

* fix translations json

* add csv.useByteOrderMarkEncoding to schema

* imports cleanup

* restore "get default chromium sandbox disabled" functionality

* integrate getDefaultChromiumSandboxDisabled

* fix tests

* --wip-- [skip ci]

* add more schema tests

* diff prettiness

* trash legacy files that moved to NP

* create_config tests

* Hoist create_config

* better disableSandbox tests

* fix ts

* fix export

* fix bad code

* make comments better

* fix i18n

* comment

* automatically setting... logs

* replace log_configuration

* fix lint

* This is f2

* improve startup log about sandbox info

* update docs with log reference

* revert log removal

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-04-15 14:52:32 -07:00
Kaarina Tungseth
84f6885c36
[DOCS] Removed spatial references (#59595)
* [DOCS] Removed ss above spatial references

* Removed above from n numeral formatting page
2020-03-09 10:29:25 -05:00
gchaps
8d37637c07
[DOCS][Reporting] Updates introduction and troubleshooting sections" (#54036)
* [Reporting/Docs] Various Documentation Additions

- Add ECONNREFUSED to troubleshooting page:
- System Requirements for Reporting
- Layout and Sizing

* [DOCS][Reporting] Updates index and troubleshooting pages

Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>
2020-01-06 12:44:42 -08:00
gchaps
23dfad304f
[DOCS] Adds note on date-math expressions in reporting (#53628) 2019-12-19 13:23:00 -08:00
Marco Vettorello
5342dd19a4
docs: fix list and a wrong copy/paste (#51908) 2019-12-19 17:54:28 +01:00