maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[DOCS] Edits copy in Reporting Diagnostics tool (#77833)

Browse source 
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This commit is contained in:
gchaps 2020-09-29 09:12:13 -07:00 committed by GitHub
parent aa9131f641
commit dffd631217
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/user/reporting/reporting-troubleshooting.asciidoc
View file

@ -18,8 +18,11 @@ Having trouble? Here are solutions to common problems you might encounter while
[float]
[[reporting-diagnostics]]
=== Reporting Diagnostics
Reporting comes with a built-in utility to try to automatically find common issues. When Kibana is running, navigate to the Report Listing page, and click the "Run reporting diagnostics..." button. This will open up a diagnostic tool that checks various parts of the Kibana deployment to come up with any relevant recommendations.
=== Reporting diagnostics
Reporting comes with a built-in utility to try to automatically find common issues.
When {kib} is running, navigate to the Report Listing page, and click *Run reporting diagnostics*.
This will open up a diagnostic tool that checks various parts of the {kib} deployment and
come up with any relevant recommendations.
[float]
[[reporting-troubleshooting-system-dependencies]]

29
x-pack/plugins/reporting/public/components/report_diagnostic.tsx
View file

@ -107,13 +107,13 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
const steps = [
{
title: i18n.translate('xpack.reporting.listing.diagnosticConfigTitle', {
defaultMessage: 'Verify Kibana Configuration',
defaultMessage: 'Verify Kibana configuration',
}),
children: (
<Fragment>
<FormattedMessage
id="xpack.reporting.listing.diagnosticConfigMessage"
defaultMessage="This check ensures your Kibana configuration is setup properly for reports."
defaultMessage="Ensure your Kibana configuration is properly set up for reports."
/>
<EuiSpacer />
<EuiButton
@ -124,7 +124,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
>
<FormattedMessage
id="xpack.reporting.listing.diagnosticConfigButton"
defaultMessage="Verify Configuration"
defaultMessage="Verify configuration"
/>
</EuiButton>
</Fragment>
@ -136,14 +136,13 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
if (configStatus === 'complete') {
steps.push({
title: i18n.translate('xpack.reporting.listing.diagnosticBrowserTitle', {
defaultMessage: 'Check Browser',
defaultMessage: 'Check browser',
}),
children: (
<Fragment>
<FormattedMessage
id="xpack.reporting.listing.diagnosticBrowserMessage"
defaultMessage="Reporting utilizes a headless browser to generate PDF and PNGS. This check validates
that the browser can launch successfully."
defaultMessage="Reporting uses a headless browser to generate PDF and PNGs. Validate that the browser can launch successfully."
/>
<EuiSpacer />
<EuiButton
@ -154,7 +153,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
>
<FormattedMessage
id="xpack.reporting.listing.diagnosticBrowserButton"
defaultMessage="Check Browser"
defaultMessage="Check browser"
/>
</EuiButton>
</Fragment>
@ -166,13 +165,13 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
if (chromeStatus === 'complete') {
steps.push({
title: i18n.translate('xpack.reporting.listing.diagnosticScreenshotTitle', {
defaultMessage: 'Check Screen Capture Capabilities',
defaultMessage: 'Check screen capture',
}),
children: (
<Fragment>
<FormattedMessage
id="xpack.reporting.listing.diagnosticScreenshotMessage"
defaultMessage="This check ensures the headless browser can capture a screenshot of a page."
defaultMessage="Ensure that the headless browser can capture a screenshot of a page."
/>
<EuiSpacer />
<EuiButton
@ -183,7 +182,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
>
<FormattedMessage
id="xpack.reporting.listing.diagnosticScreenshotButton"
defaultMessage="Capture Screenshot"
defaultMessage="Capture screenshot"
/>
</EuiButton>
</Fragment>
@ -201,7 +200,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
<Fragment>
<FormattedMessage
id="xpack.reporting.listing.diagnosticSuccessMessage"
defaultMessage="Excellent! Everything looks like shipshape for reporting to function!"
defaultMessage="Everything looks good for reporting to function."
/>
</Fragment>
),
@ -212,7 +211,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
if (!success) {
steps.push({
title: i18n.translate('xpack.reporting.listing.diagnosticFailureTitle', {
defaultMessage: "Whoops! Looks like something isn't working properly.",
defaultMessage: "Something isn't working properly.",
}),
children: (
<Fragment>
@ -228,7 +227,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
<EuiSpacer />
<FormattedMessage
id="xpack.reporting.listing.diagnosticFailureDescription"
defaultMessage="Here are some more details about the issue:"
defaultMessage="Here are some details about the issue:"
/>
<EuiSpacer />
<EuiCodeBlock>{logs}</EuiCodeBlock>
@ -257,7 +256,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
<EuiText color="subdued">
<FormattedMessage
id="xpack.reporting.listing.diagnosticDescription"
defaultMessage="Automatically run a series of diagnostics to troubleshoot common reporting problems."
defaultMessage="Run diagnostics to automatically troubleshoot common reporting problems."
/>
</EuiText>
</EuiFlyoutHeader>
@ -273,7 +272,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
<EuiButtonEmpty size="xs" flush="left" onClick={showFlyout}>
<FormattedMessage
id="xpack.reporting.listing.diagnosticButton"
defaultMessage="Run reporting diagnostics..."
defaultMessage="Run reporting diagnostics"
/>
</EuiButtonEmpty>
</div>

2
x-pack/plugins/reporting/public/components/report_listing.tsx
View file

@ -154,7 +154,7 @@ class ReportListingUi extends Component<Props, State> {
<p>
<FormattedMessage
id="xpack.reporting.listing.reports.subtitle"
defaultMessage="Find reports generated in Kibana applications here"
defaultMessage="Get reports generated in Kibana applications."
/>
</p>
</EuiText>