From ae2ef9f95ac6a5959fd675070e867ed6390e21ff Mon Sep 17 00:00:00 2001 From: Kim <56411016+kimsauce@users.noreply.github.com> Date: Mon, 19 Sep 2022 12:26:08 -0700 Subject: [PATCH 1/3] AWS Cost explorer --- docs/integrations/amazon-aws/cost-explorer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/amazon-aws/cost-explorer.md b/docs/integrations/amazon-aws/cost-explorer.md index 40b0a5a9da..88810538ce 100644 --- a/docs/integrations/amazon-aws/cost-explorer.md +++ b/docs/integrations/amazon-aws/cost-explorer.md @@ -51,7 +51,7 @@ account={{account}} region CostUsd CostType StartDate EndDate MetricType Granula ## Create an AWS Cost Explorer Source -When you create an AWS Cost Explorer collector Source, you add it to an existing Sumo Logic hosted collector. Before creating the Source, you'll need to add a Field-in-Field Schema, Field Extraction Rules, and identify or create the hosted collector you want to use. For further instructions, see [Create a Hosted Collector](/docs/Send-Data/Hosted-Collectors#Create-a-Hosted-Collector). +When you create an AWS Cost Explorer collector Source, you add it to an existing Sumo Logic hosted collector. Before creating the Source, you'll need to add a Field-in-Field Schema, Field Extraction Rules, and [identify or create the hosted collector you want to use](/docs/Send-Data/Hosted-Collectors#Create-a-Hosted-Collector). ### Field-in-Field Schema From 835f4cc91aabe2537d3d6a1e1492d4cc6ebd8011 Mon Sep 17 00:00:00 2001 From: Kim <56411016+kimsauce@users.noreply.github.com> Date: Mon, 19 Sep 2022 23:53:27 -0700 Subject: [PATCH 2/3] Word list, glossary, URL fixes, missing descriptions --- ...races-collection-for-other-environments.md | 2 +- docs/contributing/create-document.md | 6 +- docs/contributing/index.md | 2 +- ...wn-features.md => markdown-cheat-sheet.md} | 69 +++- docs/contributing/release-notes.md | 4 + docs/contributing/style-guide.md | 373 ++++++------------ docs/contributing/templates/template-doc.md | 2 +- docs/contributing/translations.md | 5 + docs/contributing/word-list.md | 48 +-- docs/cse/ingestion/auth0.md | 2 +- .../aws-application-load-balancer.md | 2 +- docs/cse/ingestion/aws-cloudtrail.md | 2 +- docs/cse/ingestion/aws-guardduty.md | 2 +- docs/cse/ingestion/aws-network-firewall.md | 2 +- docs/cse/ingestion/aws-vpc-flow.md | 2 +- docs/cse/ingestion/carbon-black.md | 2 +- docs/cse/ingestion/check-point-firewall.md | 2 +- docs/cse/ingestion/cisco-asa.md | 2 +- docs/cse/ingestion/cisco-meraki.md | 2 +- docs/cse/ingestion/corelight-zeek.md | 2 +- docs/cse/ingestion/fortigate-firewall.md | 2 +- docs/cse/ingestion/g-suite-alert-center.md | 2 +- .../ingestion/google-g-suite-apps-audit.md | 2 +- docs/cse/ingestion/kemp-loadmaster.md | 2 +- docs/cse/ingestion/linux-os-syslog.md | 2 +- docs/cse/ingestion/microsoft-audit-office.md | 2 +- .../ingestion/microsoft-azure-activity-log.md | 2 +- docs/cse/ingestion/microsoft-windows.md | 2 +- docs/cse/ingestion/nginx-access-logs.md | 2 +- docs/cse/ingestion/okta.md | 2 +- docs/cse/ingestion/onelogin.md | 2 +- docs/cse/ingestion/osquery.md | 2 +- docs/cse/ingestion/palo-alto-firewall.md | 2 +- docs/cse/ingestion/sentinelone.md | 2 +- docs/cse/ingestion/signal-sciences-waf.md | 2 +- ...ec-proxy-secure-gateway-blue-coat-proxy.md | 2 +- .../symantec-proxy-secure-gateway.md | 2 +- docs/cse/ingestion/zscaler-nss.md | 2 +- docs/cse/ingestion/zscaler-private-access.md | 2 +- .../integrations/forward-cse-data-to-sumo.md | 2 +- .../forward-cse-signals-to-sumo.md | 2 +- .../{about-dashboard-new.md => about.md} | 35 +- ...board_new.md => create-a-dashboard-new.md} | 0 docs/dashboards-new/explore-view.md | 4 +- .../{dashboard-new-faqs.md => faq.md} | 6 +- docs/dashboards-new/index.md | 15 + docs/dashboards-new/link-dashboard-new.md | 30 -- ...ashboard-explore.md => link-dashboards.md} | 37 +- docs/dashboards-new/locate-deviations.md | 2 +- docs/dashboards-new/panels.md | 11 +- docs/dashboards-new/panels/bubble-charts.md | 2 +- docs/dashboards-new/panels/scatter-charts.md | 2 +- .../{about-dashboards.md => about.md} | 2 +- .../dashboards/share-dashboard-outside-org.md | 12 +- docs/get-started/account-setup.md | 2 +- docs/get-started/admin.md | 2 +- docs/get-started/glossary.md | 3 +- docs/get-started/help.md | 2 +- docs/get-started/index.md | 6 +- docs/get-started/sign-up.md | 2 +- docs/integrations/amazon-aws/config.md | 2 +- .../aws-cloudtrail-pci-compliance.md | 2 +- .../linux.md | 2 +- .../docker-enterprise-edition.md | 2 +- docs/integrations/microsoft-azure/iis-7.md | 6 +- docs/manage/collection/upgrade-collectors.md | 4 +- .../cloud-flex-accounts.md | 4 +- .../pause-disable-scheduled-views.md | 2 +- docs/manage/security/access-keys.md | 2 +- .../security/saml/integrate-onelogin.md | 4 +- docs/manage/users-and-roles/index.md | 2 +- docs/manage/users-and-roles/roles/index.md | 2 +- docs/manage/users-and-roles/users/index.md | 2 +- .../metric-queries-alerts/engine-updates.md | 4 +- docs/observability/kubernetes/quickstart.md | 2 +- docs/releasenotes/cloud-siem.md | 4 +- docs/search/live-tail/live-tail-cli.md | 4 +- .../search-operators/dedup.md | 2 +- .../collect-logs-sentinelone.md | 2 +- .../collect-ruby-on-rails-logs.md | 2 +- docs/send-data/collector-faq.md | 2 +- .../aws-kinesis-firehose-logs-source.md | 2 +- .../1password-source.md | 2 +- .../akamai-siem-api-source.md | 2 +- .../azure-event-hubs-source.md | 2 +- .../box-source.md | 2 +- .../carbon-black-cloud-source.md | 2 +- .../carbon-black-inventory-source.md | 2 +- .../cisco-amp-source.md | 2 +- .../crowdstrike-fdr-source.md | 2 +- .../crowdstrike-source.md | 2 +- .../cse-aws-ec-inventory-source.md | 2 +- .../cybereason-source.md | 2 +- .../cylance-source.md | 2 +- .../dropbox-source.md | 2 +- .../duo-source.md | 2 +- .../google-workspace-source.md | 2 +- .../microsoft-azure-ad-inventory-source.md | 2 +- .../microsoft-graph-security-api-source.md | 2 +- .../mimecast-source.md | 2 +- .../ms-graph-azure-ad-reporting-source.md | 2 +- .../ms-graph-identity-protection-source.md | 2 +- .../netskope-source.md | 2 +- .../netskope-webtx.md | 2 +- .../okta-source.md | 2 +- .../palo-alto-cortex-xdr-source.md | 2 +- .../proofpoint-on-demand-source.md | 2 +- .../proofpoint-tap-source.md | 2 +- .../sailpoint-source.md | 2 +- .../salesforce-source.md | 2 +- .../sentinelone-mgmt-api-source.md | 2 +- .../sophos-central-source.md | 2 +- .../symantec-web-security-service-source.md | 2 +- .../tenable-source.md | 2 +- .../http-source/logs-metrics.md | 2 +- docs/send-data/hosted-collectors/index.md | 2 +- .../binary-package-install-a-collector.md | 4 +- docs/send-data/installed-collectors/linux.md | 2 +- docs/send-data/installed-collectors/macos.md | 2 +- ...orwarded-events-windows-event-collector.md | 2 +- ...quisites-windows-remote-file-collection.md | 4 +- .../remote-windows-event-log-source.md | 2 +- .../send-data/installed-collectors/windows.md | 2 +- docs/send-data/setup-wizard.md | 2 +- .../use-json-configure-sources/index.md | 2 +- docusaurus.config.js | 2 +- sidebars.ts | 17 +- 127 files changed, 418 insertions(+), 501 deletions(-) rename docs/contributing/{markdown-features.md => markdown-cheat-sheet.md} (89%) rename docs/dashboards-new/{about-dashboard-new.md => about.md} (84%) rename docs/dashboards-new/{create_a_dashboard_new.md => create-a-dashboard-new.md} (100%) rename docs/dashboards-new/{dashboard-new-faqs.md => faq.md} (98%) create mode 100644 docs/dashboards-new/index.md delete mode 100644 docs/dashboards-new/link-dashboard-new.md rename docs/dashboards-new/{link-dashboard-explore.md => link-dashboards.md} (62%) rename docs/dashboards/{about-dashboards.md => about.md} (99%) diff --git a/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md b/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md index 4c8d8fe4ef..b63281fc2a 100644 --- a/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md +++ b/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md @@ -30,7 +30,7 @@ Due to the fact that vital metadata (information about the host and its OS) is a Installation steps require you to add a Source to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector. -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**. +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**. 1. In the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/contributing/create-document.md b/docs/contributing/create-document.md index bc3586979f..5d0add5586 100644 --- a/docs/contributing/create-document.md +++ b/docs/contributing/create-document.md @@ -20,11 +20,11 @@ Create a markdown file with filename.md in a /docs folder that best matches the ## 2. Add doc title and metadata -See [Markdown Features > Front Matter](/docs/contributing/markdown-features#front-matter) to learn how. +See [Markdown Features > Front Matter](/docs/contributing/markdown-cheat-sheet#frontmatter) to learn how. ## 3. Add doc content -See [Markdown Cheat Sheet](markdown-features.md) to learn about how to write in markdown. Doc body text content is written in GitHub-flavored markdown, with some customizations. +See [Markdown Cheat Sheet](markdown-cheat-sheet.md) to learn about how to write in markdown. Doc body text content is written in GitHub-flavored markdown, with some customizations. ### Code of Conduct @@ -63,7 +63,7 @@ The `sidebars.ts` file (in repo root) controls the side navigation for the entir link: {type: 'doc', id: 'contributing/index'}, items: [ 'contributing/create-document', - 'contributing/markdown-features', + 'contributing/markdown-cheat-sheet', 'contributing/release-notes', 'contributing/build-deploy', 'contributing/translations', diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 87de0dd105..a7dcf6aa6f 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -90,7 +90,7 @@ $ git commit -m "Updating query for metrics" #### Create a branch 1. Create a new branch from your cloned repo/fork using a name that best describes the work or references a GitHub issue number. For example: `-tracing-update` or `-apps-gitlab` -1. Edit or create markdown (.md) files in your branch. See [Create a Document](create-document.md) and [Markdown Features](markdown-features.md) for more info. +1. Edit or create markdown (.md) files in your branch. See [Create a Document](create-document.md) and [Markdown Features](markdown-cheat-sheet.md) for more info. #### Push your changes diff --git a/docs/contributing/markdown-features.md b/docs/contributing/markdown-cheat-sheet.md similarity index 89% rename from docs/contributing/markdown-features.md rename to docs/contributing/markdown-cheat-sheet.md index a03f591586..8c7c82cebd 100644 --- a/docs/contributing/markdown-features.md +++ b/docs/contributing/markdown-cheat-sheet.md @@ -1,5 +1,5 @@ --- -id: markdown-features +id: markdown-cheat-sheet title: Markdown Cheat Sheet sidebar_label: Markdown Cheat Sheet description: Learn about markdown features Docusaurus supports. @@ -14,9 +14,17 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; This is a guide to writing docs in GitHub-flavored markdown, the language in which our docs are written. -## Front Matter +## What is Markdown? -Markdown documents have metadata at the top called [front matter](https://jekyllrb.com/docs/front-matter/). Every page should have an `id` used for sidebar navigation. +Markdown is a simple, text-based format you can write using text editors, IDEs, or the GitHub website to write content. We use Docusaurus to manage, style, and build our site. We use GitHub-flavored Markdown with some additional options. Here are more guides and options: + +* [Markdown Guide](https://www.markdownguide.org/) +* [Markdown Cheatsheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf) + + +## Frontmatter + +Markdown documents have metadata at the top called [frontmatter](https://jekyllrb.com/docs/front-matter/). Every page should have an `id` used for sidebar navigation. ```markdown --- @@ -242,7 +250,7 @@ Tables use plain markdown with one header, default left aligned columns, and mul -```markdown +``` | Column Name | Example Value | Description | | :-- | :-- | :-- | | Trace ID | ffaf2f69ee8ad0c1 | The unique identifier of the trace. | @@ -255,6 +263,26 @@ Tables use plain markdown with one header, default left aligned columns, and mul | Status | 200 | The HTTP status code of the trace. | ``` + +``` +Colons can be used to align columns. + +| Tables | Are | Cool | +| ------------- |:-------------:| -----:| +| col 3 is | right-aligned | $1600 | +| col 2 is | centered | $12 | +| zebra stripes | are neat | $1 | + +There must be at least 3 dashes separating each header cell. +The outer pipes (|) are optional, and you don't need to make the +raw Markdown line up prettily. You can also use inline Markdown. + +Markdown | Less | Pretty +--- | --- | --- +*Still* | `renders` | **nicely** +1 | 2 | 3 +``` + @@ -269,6 +297,28 @@ Tables use plain markdown with one header, default left aligned columns, and mul | Number of errors | 0 | The number of errors in the trace. | | Status | 200 | The HTTP status code of the trace. | + + +Colons can be used to align columns. + +| Tables | Are | Cool | +| ------------- |:-------------:| -----:| +| col 3 is | right-aligned | $1600 | +| col 2 is | centered | $12 | +| zebra stripes | are neat | $1 | + +There must be at least 3 dashes separating each header cell. +The outer pipes (|) are optional, and you don't need to make the +raw Markdown line up prettily. You can also use inline Markdown. + +Markdown | Less | Pretty +--- | --- | --- +*Still* | `renders` | **nicely** +1 | 2 | 3 + + + + @@ -414,11 +464,11 @@ Here's a cool tip. ## Lists -You can mix ordered (or numbered) and unordered (or bulleted) lists together. Use extra lines and tabs (or 2 spaces) to move content under these bullets, including other bullets, paragraphs, images, and more. Be careful of tabbing over too far. A third tab will automatically render as code. +You can mix ordered (or numbered) and unordered (or bulleted) lists together. Use extra lines and tabs (or 2 spaces) to move content under these bullets, including other bullets, paragraphs, images, and more. Be careful of tabbing over too far. A third tab will automatically render as code. ### Numbered Lists -Always start with `1.` for numbered, ordered lists. The generator will automatically number the list correctly when building the site: +Always start with `1.` for numbered, ordered lists. The generator will automatically number the list correctly when building the site. This can be helpful when you need to add or change the order of instructions (no need to edit every number). ```markdown title="Markdown Ordered List" 1. First ordered list item. @@ -488,9 +538,12 @@ You can configure your editor to always use this format for lists. For Visual St * **Ordered List: Marker** set to *one*. * **Unordered List: Marker** set to *. + ## Code Blocks -Markdown code blocks are supported with Syntax highlighting. Always use [code block](#code-blocks) to format programming language (i.e., SQL for Sumo queries, JSON for logs). +Always use [code block](#code-blocks) to format programming language scripts (i.e., SQL for Sumo queries, JSON for logs). Format blocks of code by placing triple backticks before and after the code. + +Markdown code blocks support Syntax highlighting. If you know the code language, include that in the first set of ticks. This applies code highlighting for the language. See [this list](https://prismjs.com/#supported-languages) of available languages. To highlight lines in the code, use `{#}` in the title line with lines numbers. This example highlights lines 2 through 6. @@ -537,7 +590,7 @@ function HelloDocusaurus() { -For a full list of options, see [Docusaurus Code Blocks](https://docusaurus.io/docs/markdown-features/code-blocks). +For a full list of options, see [Docusaurus Code Blocks](https://docusaurus.io/docs/markdown-cheat-sheet/code-blocks). ### Import GitHub Repo File diff --git a/docs/contributing/release-notes.md b/docs/contributing/release-notes.md index 9238b5e742..4917c94b1a 100644 --- a/docs/contributing/release-notes.md +++ b/docs/contributing/release-notes.md @@ -3,6 +3,10 @@ id: release-notes title: Release Notes --- + + + + :::caution 🚧 Under construction 🚧 diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index 01edca8df8..7e5f36e06c 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -4,286 +4,155 @@ title: Sumo Logic Style Guide sidebar_label: Style Guide --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + :::caution -🚧 Under construction 🚧 +Under construction 🚧 ::: -The Sumo Logic Style Guide is a guide to language at Sumo Logic, so that we can speak as one company with a unified voice, and know what we mean when we talk about our product. The Style Guide began as a document used by the Documentation team to make decisions about tone, voice, and word usage. We thought it would be useful to share with everyone at the company. +The Sumo Logic Style Guide is a guide to language at Sumo Logic, so that we can speak as one company with a unified voice, and know what we mean when we talk about our product. The Style Guide began as a document used by the Documentation team to make decisions about tone, voice, and word usage. We thought it would be useful to share with everyone in our community. + +The Sumo Logic Style Guide is a living document. If you have wondered about the usage of the name of a component or feature in the UI, or any other word usage, and you don't find that term here, please let us know. The Documentation team will look it up and add usage guidance. Likewise, if you disagree with any usage defined here, please let us know and we'll update as necessary. + -The Sumo Logic Style Guide is a living document. If you have wondered about the usage of the name of a component or feature in the UI, or any other word usage, and you don't find that term here, please add it. If you're not sure about the usage, just add a question mark. The Documentation team will look it up and add usage guidance. Likewise, if you disagree with any usage defined here, please let us know and we'll update as necessary. +## Grammar and Style +If you need help with a convention, word to use, or format to follow, we will keep a cheatsheet of styles here. We also follow [Microsoft Manual of Style](https://docs.microsoft.com/en-us/style-guide/welcome/). -## Tone and Voice +For terminology usage guidance, see [Word List](docs/contributing/word-list.md). + + +## Voice and Tone * We are clear, genuine, and trustworthy. We understand that our customers entrust us with their vital data and never make light about our commitment to data access and security. * The reader should feel confident and informed. We should strive to engage our customers, and show them where to get additional assistance when needed. -* Describe Sumo Logic in a **professional** and **truthful** manner. Avoid generic, unsubstantial adjectives like "very" or phrases like "we're the best". Instead, illustrate these points by letting our product speak for itself. +* Describe Sumo Logic in a professional and truthful manner. Avoid generic, unsubstantial adjectives like "very" or phrases like "we're the best". Instead, illustrate these points by letting our product speak for itself. * Avoid using a stiff, institutional voice. Instead, write with an instructive and conversational tone. For example, when linking to the support site, use terms like "Need help? Let us know" instead of "Please email our support personnel" to give our company a friendly face. -* Use the **active voice** whenever possible. For example, use "Brutus stabbed Caesar," not "Caesar was stabbed by Brutus." -* Instructional content and blog posts should be written at approximately the 8th-grade reading level, particularly in introductory sections, for readability and SEO. You can test your content here: [http://www.writingtester.com/tester/grade_level.php](http://www.writingtester.com/tester/grade_level.php). +* Use the [active voice](#active-voice) whenever possible. For example, use "Brutus stabbed Caesar," not "Caesar was stabbed by Brutus." +* Instructional content and blog posts should be written at approximately the 8th-grade reading level, particularly in introductory sections, for readability and SEO. You can test your content [here](http://www.writingtester.com/tester/grade_level.php). * When explaining a process or procedure, clarity is critical. Edit words that distract or confuse. Put yourself into the reader's shoes and think about what actions you are recommended to them when an error message is displayed, rather than merely stating what went wrong. Example: "Could not create the user." vs "This email is already registered in the system. Please use a different email or contact Sumo Logic for assistance." +* We use the Oxford (serial) comma. For example, use "I had eggs, toast, and orange juice", not "I had [eggs, toast and orange juice](https://www.verbicidemagazine.com/wp-content/uploads/2012/01/why-i-still-use-the-oxford-comma.jpg)". * We have a sense of humor! Conveying that we do serious work, but we don't take ourselves too seriously, makes Sumo Logic feel likable. -* We use the Oxford, or serial, comma. For example: "I had [eggs, toast, and orange juice](https://www.verbicidemagazine.com/wp-content/uploads/2012/01/why-i-still-use-the-oxford-comma.jpg)." - -For a general overview of how to improve your writing, see [Tips for Better Writing at Sumo Logic](https://wiki.kumoroku.com/confluence/display/MAIN/Tips+for+Better+Writing+at+Sumo+Logic). - - -## Writing for SEO - -For clarity and search engine discoverability: - -* Doc titles are very important for SEO. Use primary target keywords, try to mention "Sumo Logic, and keep length under 60 characters. - * Example: ~~_Monitoring with the Observability Solution_~~ → _Monitoring with Sumo Logic Observability_ -* Use H2 sections to break up content and try to use primary keywords here as well. - * Example: _AWS Observability Solution_. -* H3 and H4 headers don't impact SEO as much. Use short, meaningful titles for readability and search. - * Example: _System architecture and monitoring_. - -:::sumo For internal contributors -* If you change a URL, set up a redirect so that users don’t get a 404 page. -* Use Google Analytics to make data-driven decisions. -::: -## Writing Style Guide +### Structuring Content -If you need help with a convention, word to use, format to follow, we will keep a cheatsheet of styles here! We also follow [Microsoft Manual of Style](https://docs.microsoft.com/en-us/style-guide/welcome/). - -### Formatting Text - -Cheatsheet when to use different formats. Here's the Microsoft Style Guide for [User Input](https://docs.microsoft.com/en-us/style-guide/procedures-instructions/formatting-text-in-instructions) for more info. - -* Use _italics_ when defining a term the first time. For example, when defining a collector the first time, you would italicize once with the definition. -* Use **bold** for UI elements you interact with, such as a button or tab. -* Use _italics_ for content to enter into a field. -* Use \code ticks for inline code and triple ticks for blocks of code. This is important for scripts and CLI. - -This is a great example for these styles: If you are not parsing all sources in the hosted collector with the same parser, click the **+Add Field** link, and add a field whose name is `_parser` with value _/Parsers/System/Auth0/Auth0_. - -### Headings - -A heading is a great way to group content. When you use Google Docs or Microsoft Word, you select a drop-down menu to assign a heading format. We use # to create them. Use headings for concepts, steps in complicated procedures, and so on. - -Here is a cheatsheet for those: - -* We mark a heading using a number of # for the level. This section is using a heading 3 which is `### Headings`. -* The title of the page is heading 1. Never use heading 1 (#) in your document. This affects Google and search engine results for the page. -* Headings should always be clean, plain text. Do not use **bold**, _italics_, or code ticks! - -* Be careful of using special characters. We recommend not using most punctuation. Dashes are ok for headings. - -### Acronyms - -All companies have numerous acronyms for product, features, solutions, and more. Our documentation includes acronyms for Sumo Logic and third party software. Always fully spell out the first instance of the acronym on the page, then you can use it throughout. Do not spell out in a heading, but in paragraphs or bullets. - -For example, the first time you use AWS Application Load Balancer (ALB), you introduce or use it like that the first time on the page. Through the rest of the page, you can use ALB. - -### Contractions +* Tell the user in the doc introduction (first paragraph) what the page teaches, why they should read it, and who should read it. +* Let the user know what step/place they are in for a tutorial in the introduction/at top. The layout automatically provides a previous/next at the bottom of the page. +* Link out to important concepts and overviews for additional reading. This is helpful for instruction pages or tutorials. +* Keep instructions concise, easy to follow, not too many screenshots. +* Include any notes, warnings, etc. -For writing in English, contractions feel like normal, everyday speech. But they can cause issues with translation, especially if someone uses Google Chrome translation or other tools and when we hire companies to translate content. We recommend not using contractions. Spell out all words. This includes don't, it's, haven't, and so on. ### Active Voice When writing instructions, it helps to always use active voice. This gives a call to action for the reader or user to effectively get something done. It also reduces word count and keeps instructions clear. -Here is a cheatsheet: - | Good Active | Not Active | Why? | | -- | -- | -- | | Add a resource... | You can add a resource... | They know they can do a thing. Clearly state to do the thing. | | Build the query using the following... | Please build the query using the following... | We need them to complete a task. No need for please. | | To add a new collector:
1. Access Sumo Logic and find the... | 1. When you need to add a new collector, access Sumo Logic and find the... | Introduce your instructions with the goal, then dive into the instructions. This is called a stem, and it helps focus the task and keeps you active. | -## Writing Resources - -If you are new to writing content or would like to learn more, see these resources. The Sumo Logic Docs team will review submissions, provide suggested edits, add new content into the navigation, and answer any questions you have. - -* [Write the Docs](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/) - Association of tech writers, developers, trainers, and more that have collected ideas, created training and guidelines, and actively discuss documentation. -* [Google Technical Writing Courses](https://developers.google.com/tech-writing) - Excellent and easy self-paced courses to refine your writing. Be advised, the courses may use a different style, but still excellent to get started. -* [Every Page is Page One](https://everypageispageone.com/examples-of-eppo-topics/) - A helpful method for considering what goes into a page is to think of every page as page one. With the extreme use of search engines or sharing a link to find content, users may land in the middle of a section or tutorial. These ideas help hone your content and focus on user needs. - -Helpful blogs on tech writing: -* [Usability and Tech Writing](https://www.nngroup.com/topic/writing-web/) - Jakob Neilson defined usability, including insights on technical writing and learning, helpful for writing docs -* [FFeathers tech writing](https://ffeathers.wordpress.com/) - Pioneered API and technical tech writing, insights and instructions -* [I'd rather be writing](https://idratherbewriting.com/) - Guides and thoughts on tech writing process and content - -This list of resources will grow! - -### Focused Content - -These guidelines help you focus content and decide what to write per page: - -* The introduction is the first paragraph someone reads. It should tell them what this page teaches, why they should read it, and who should read it. -* Let the user know what step/place they are in for a tutorial in the introduction/at top. The layout automatically provides a previous/next at the bottom of the page. -* Link out to important concepts and overviews for additional reading. This is helpful for instruction pages or tutorials. -* Keep instructions concise, easy to follow, not too many screenshots. -* Include any notes, warnings, etc. - -## Markdown Style Guide - -See [Markdown Formats and Templates](#Markdown-Formats-and-Templates) for examples, usage, and templates for Markdown. It is a simple, text-based format using text editors, IDEs, or the GitHub website to write content. We use Gatsby to manage, style, and build our site. - -Learn more about Markdown with this guide! We use GitHub flavored Markdown with some additional options. Here are more guides and options: - -* [Markdown Guide](https://www.markdownguide.org/) -* [Markdown Cheatsheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf) - -## Filename - -A Markdown file has a filename and extension of .md. We recommend keeping the filename short. It does not affect the canonical link. - -## Elements of a Page - -We provide templates (coming soon) to help create a new page. Every page includes the following: - -* Frontmatter - This is the metadata for a webpage, including the title, description, and search keywords. -* Headings - These mark the sections, from H2 (##) to H5 (#####). Use H1 only once at the top for the title. -* Content - All of the content, including paragraphs, lists, instructions, images, graphs, and more. - -## Frontmatter - -Every file begins with front matter or metadata for your content. This information includes: - -``` ---- -id: page-id -sidebar_title: Navigation title -description: Learn more about... ---- - -# Title of the Page -``` +### Acronyms -| Parameter | Description | -| -- | -- | -| `id:` | Id for the page used in the sidebar and as the canonical link. | -| `sidebar_title:` | Optional, use a different title for the side navigation. It does not affect the canonical link or page title. | -| `description:` | 1 sentence describing what the user will find in the page for searches. Otherwise the first couple sentences are used for searches. | +An acronym uses the first initials of a word or phrase, for brevity. Our industry is full of them, and they can get confusing if their usage isn't clear. Acronyms should be capitalized, if not used directly in a query, etc. Unless the usage is clear from the context, for the first usage, spell out the phrase, then present the acronym in parenthesis. For example: Secure Shell (SSH). -## Paragraphs -As you start writing content, it automatically generates along the left side (or margin). To create a paragraph, leave an empty line between sentences. +All companies have numerous acronyms for product, features, solutions, and more. Our documentation includes acronyms for Sumo Logic and third party software. Always fully spell out the first instance of the acronym on the page, then you can use it throughout. Do not spell out in a heading, but in paragraphs or bullets. -If you need to indent content, use the tab key or enter 2 spaces. Each tab moves content to the right, indenting the page content. +For example, the first time you use AWS Application Load Balancer (ALB), you introduce or use it like that the first time on the page. Through the rest of the page, you can use ALB. -## Text effects -To format for bolding and italics, see the following: +### Contractions -| Example | Output | -| -- | -- | -| `*emphasis*` | *emphasis* | -| `**bold**` | **bold** | +For writing in English, contractions feel like normal, everyday speech. But they can cause issues with translation, especially if someone uses Google Chrome translation or other tools and when we hire companies to translate content. We recommend not using contractions. Spell out all words. This includes don't, it's, haven't, and so on. -## Bulleted lists +### UI Element Names -We recommend using a dash (-) for each line in a bulleted list. Lists also support *. +Not everything has an intuitive name. It's the very nature of working with a constantly evolving product. Here are some examples: -``` -* List Item 1 -* List Item 2 +| What does it look like? | What does Sumo call it? | +|:------------------------|:--------------------| +| x | Three-dot icon | +| x | Navigation Menu | +| x | Favorites | +| x | Personal Folder | +| x | Recents | +| x | Library | - * Indented List Item - * Another one -``` -* List Item 1 -* List Item 2 +### Patents and trademarks - * Indented List Item - * Another one +Protecting our patents and trademarks is important to do correctly. We don't want to expose the company to a loss of trademark or patent just because we didn't list it correctly. -## Numbered steps -Numbered lists add numbers to a set of instructions or steps. Start every line with 1. When building the documentation, the instructions automatically number for you. This is helpful when you need to add or change the order of instructions. You do not need to edit every number. +This is a partial list of trademarked terms, which should be capitalized exactly as shown below. -``` -1. Access Sumo Logic and select your account then **Preferences**. -1. Under Access Keys, click **Create**. -1. Enter... -``` +* Sumo Logic +* Big Data for Real Time IT +* Log Reduce +* Elastic Log Processing +* Push Analytics -1. Access Sumo Logic and select your account then **Preferences**. -1. Under Access Keys, click **Create**. -1. Enter... +Never use Sumo Logic in the plural or possessive form. -## Tables -Simple tables can help format content. For example, lists of attributes with descriptions. Adding the style below the table helps with formatting. +## Writing for SEO -``` -Colons can be used to align columns. - -| Tables | Are | Cool | -| ------------- |:-------------:| -----:| -| col 3 is | right-aligned | $1600 | -| col 2 is | centered | $12 | -| zebra stripes | are neat | $1 | - -There must be at least 3 dashes separating each header cell. -The outer pipes (|) are optional, and you don't need to make the -raw Markdown line up prettily. You can also use inline Markdown. - -Markdown | Less | Pretty ---- | --- | --- -*Still* | `renders` | **nicely** -1 | 2 | 3 -``` +For clarity and search engine discoverability: -Colons can be used to align columns. +* Doc titles are very important for SEO. Use primary target keywords, try to mention "Sumo Logic, and keep length under 60 characters. + * Example: ~~_Monitoring with the Observability Solution_~~ → _Monitoring with Sumo Logic Observability_ +* Use H2 sections to break up content and try to use primary keywords here as well. + * Example: _AWS Observability Solution_. +* H3 and H4 headers don't impact SEO as much. Use short, meaningful titles for readability and search. + * Example: _System architecture and monitoring_. -| Tables | Are | Cool | -| ------------- |:-------------:| -----:| -| col 3 is | right-aligned | $1600 | -| col 2 is | centered | $12 | -| zebra stripes | are neat | $1 | +:::sumo For internal contributors +* If you change a URL, set up a redirect so that users don’t get a 404 page. +* Use Google Analytics to make data-driven decisions. +::: -There must be at least 3 dashes separating each header cell. -The outer pipes (|) are optional, and you don't need to make the -raw Markdown line up prettily. You can also use inline Markdown. +## File Naming Convention -Markdown | Less | Pretty ---- | --- | --- -*Still* | `renders` | **nicely** -1 | 2 | 3 +A Markdown file has a filename and extension of .md. We recommend keeping the filename short. It does not affect the canonical link. -## Links -Adding links to content outside of documentation: `[GitHub](http://github.com)` +## Metadata -Adding links between pages are relative links with the path and name of the file without the .md or .mdx extension. +We refer to our doc site metadata (i.e., title, description, and search keywords), located in the header, as _frontmatter_. [Learn more](/docs/contributing/markdown-cheat-sheet#frontmatter). -## Images -We recommend saving all images in PNG format. Images are typically saved in the */static/images* folder location. Always include alt text for images. +## Formatting Text -Use the following format for placing images inline (paragraphs, tables, bullets, etc) and in its own line: +Here's a guide to text formatting. See the Microsoft Style Guide for [User Input | Formatting Text in Instructions](https://docs.microsoft.com/en-us/style-guide/procedures-instructions/formatting-text-in-instructions) for more info. -``` -![Alt Text](/images/filename.png) -``` +### Headings -## Notes and Callouts +Use headings to group content. These mark the sections, from H2 (##) to H5 (#####). -Notes and callouts are annotations. Use annotations to highlight information, including tips, notes, warnings, etc. +* We mark a heading using a number of # for the level. This section is using an H3 heading, which is `### Headings`. +* Never use H1 (`#`) in your document. Page titles, which are displayed as H1, live in the metadata section (i.e., front matter) for SEO. +* Headings should always be clean, plain text. Do not use **bold**, _italics_, or code ticks. +* Be careful of using special characters. We recommend not using most punctuation. Dashes are ok for headings. -```markdown -:::note Title for the Note -Add markdown here. This supports note, tip, info, warning, important, and some custom looks like contribution and training! +### Italics -Make sure to have a blank line above and below the whole section. You can also use code, code blocks, tables, and much more in these callouts. -::: -``` +Use _italics_ for: +* Defining a term the first time. For example, when defining a collector the first time, you would italicize once with the definition. +* Providing content to enter into a field. -A visual example will be provided in a template. +### Bold -## Code +* Use **bold** for UI elements you interact with, such as a button or tab. -Use the following formats for commands, API method names, and code. +### Code (Inline) -Inline code examples use single ticks around `text` for code formatting. +* Use \` \` single backticks to format inline code, such as commands, API method names, and code. For information on code blocks (scripts), see [Code Blocks](#code-blocks). -Here is an example of `code` inline. +Here's an example that encompasses all the above styles: If you are not parsing all sources in the hosted collector with the same parser, click the **+Add Field** link, and add a field whose name is `_parser` with value _/Parsers/System/Auth0/Auth0_. -For blocks of code, use triple ticks (```) before and after the code. If you know the code language, include that in the first set of ticks, for example ```json. This applies code highlighting for the language. See [this list](https://prismjs.com/#supported-languages) of available languages. +### Code Blocks -The following is an example of JSON: +Use code blocks to format scripts, such as the JSON example below. This is important for scripts and CLI. [Here's how to write it in markdown](/docs/contributing/markdown-cheat-sheet#code-blocks). ```json { @@ -295,48 +164,31 @@ The following is an example of JSON: } ``` -## Templates - -To quickly create a page, use a template. You can copy and paste the file, add your content, and submit a PR. If you need formats for specific code, see the formats template. - -(coming soon) -* Doc topic - Use for any documentation page -* APIs - Use for API and code -* Format template +### Numbered lists +Use numbered lists when providing a set of instructions or steps. [Here's how to write it in markdown](/docs/contributing/markdown-cheat-sheet#Numbered-Lists). -## Names for cool stuff in the UI +### Bulleted lists -Not everything has an intuitive name, it's the very nature of working with a constantly evolving product. Here are the best names we have so far from the design team. +Use bulleted lists when the items don't need to be presented in sequential order. Ensure parallel grammatical structure - that is, start each bullet with the same part of speech. [Here's how to write it in markdown](/docs/contributing/markdown-cheat-sheet#bulleted-Lists). -| What does it look like? | What do we call it? | -|:------------------------|:--------------------| -| x | Three-dot icon | -| x | Navigation Menu | -| x | Favorites | -| x | Personal Folder | -| x | Recents | -| x | Library | +### Tables +Simple tables can help format content. For example, lists of attributes with descriptions. Adding the style below the table helps with formatting. [Here's how to write it in markdown](/docs/contributing/markdown-cheat-sheet#tables). +### Notes and Callouts +We refer to callout elements like Tip, Note, Warning, and Caution as admonitions. [Here's how to write them in markdown](/docs/contributing/markdown-cheat-sheet#admonitions). -## Patents and trademarks -Protecting our patents and trademarks is important to do correctly. We don't want to expose the company to a loss of trademark or patent just because we didn't list it correctly. - -This is a partial list of trademarked terms, which should be capitalized exactly as shown below. - -* Sumo Logic -* Big Data for Real Time IT -* Log Reduce -* Elastic Log Processing -* Push Analytics - -Never use in the plural or possessive form. +## Images +* Images should be in PNG or GIF format +* Always include image alt text +* Width parameters should be used for oversized images +[Here's how to write it in markdown](/docs/contributing/markdown-cheat-sheet#images). -## Screenshots +#### Screenshots Capture screenshots using SnagIt in .png format. Use SnagIt's border effect to apply a gray (RGB 212, 212, 212) 4-point border. @@ -348,10 +200,35 @@ There's an exception to this rule: you may need to manually change the size of a The solution is to resize the image to be 750 px wide. To do so in the visual editor, grab the upper right corner and size the image manually until it is 750 px wide. The height will adjust proportionately. -## Masking sensitive information +#### Masking sensitive information We mask sensitive information, like user names, email addresses, IP addresses, and so on. In [Snagit](https://www.techsmith.com/screen-capture.html) or a similar program, use the shape tool to mask the text using solid gray, (RGB 212, 212, 212). -## Callouts +#### Callouts Create callouts using the shape tool in SnagIt. Callouts should be red, 100% opacity, no drop shadow effect, 2 pts wide. + + + +### Additional Resources + +If you are new to writing content or would like to learn more, see these resources. The Sumo Logic Docs team will review submissions, provide suggested edits, add new content into the navigation, and answer any questions you have. + +* [Write the Docs](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/) - Association of tech writers, developers, trainers, and more that have collected ideas, created training and guidelines, and actively discuss documentation. +* [Google Technical Writing Courses](https://developers.google.com/tech-writing) - Excellent and easy self-paced courses to refine your writing. Be advised, the courses may use a different style, but still excellent to get started. +* [Every Page is Page One](https://everypageispageone.com/examples-of-eppo-topics/) - A helpful method for considering what goes into a page is to think of every page as page one. With the extreme use of search engines or sharing a link to find content, users may land in the middle of a section or tutorial. These ideas help hone your content and focus on user needs. + +Helpful blogs on tech writing: + +* [Usability and Tech Writing](https://www.nngroup.com/topic/writing-web/) - Jakob Neilson defined usability, including insights on technical writing and learning, helpful for writing docs +* [FFeathers tech writing](https://ffeathers.wordpress.com/) - Pioneered API and technical tech writing, insights and instructions +* [I'd rather be writing](https://idratherbewriting.com/) - Guides and thoughts on tech writing process and content + +### Doc Templates + +To quickly create a page, use a template. You can copy and paste the file, add your content, and submit a PR. If you need formats for specific code, see the formats template. + +(coming soon) +* Doc topic - Use for any documentation page +* APIs - Use for API and code +* Format template diff --git a/docs/contributing/templates/template-doc.md b/docs/contributing/templates/template-doc.md index 5e4d5ea16e..0f4b8e86f4 100644 --- a/docs/contributing/templates/template-doc.md +++ b/docs/contributing/templates/template-doc.md @@ -6,7 +6,7 @@ description: Example template for creating a document in the Sumo Logic guides. --- :::note -Copy this markdown file and fill it out for documentation. See the markdown code to see how it all works. For full markdown code and options, see [Markdown Features](../markdown-features.md). +Copy this markdown file and fill it out for documentation. See the markdown code to see how it all works. For full markdown code and options, see [Markdown Features](../markdown-cheat-sheet.md). ::: Replace the H1 title above with the title for your documentation page. You should only every have one H1 entry used for the title. All other sections should be H2, H3, ...H5. diff --git a/docs/contributing/translations.md b/docs/contributing/translations.md index ea8d7913c4..764a41eae8 100644 --- a/docs/contributing/translations.md +++ b/docs/contributing/translations.md @@ -5,6 +5,11 @@ sidebar_label: Translating Docs description: Learn about our doc translation process. --- +:::caution + +🚧 Under construction 🚧 +::: + All content in /docs folder is the English language documentation, the source of truth for all content. For full information on translations and commands, see [Docusaurus i18n](https://docusaurus.io/docs/i18n/introduction). :::sumo Doc Team Support diff --git a/docs/contributing/word-list.md b/docs/contributing/word-list.md index 80b7639467..14e8a2fb4d 100644 --- a/docs/contributing/word-list.md +++ b/docs/contributing/word-list.md @@ -1,21 +1,17 @@ --- id: word-list title: Word List -hide_table_of_contents: true +description: An alphabetized list of commonly used terms at Sumo Logic, including components and features of Sumo Logic, and other usage issues, such as punctuation and capitalization. --- - - - - :::caution 🚧 Under construction 🚧 ::: -This word list provides an alphabetized list of commonly used terms at Sumo Logic, including components and features of the Sumo Logic Web Application, and other usage issues, such as punctuation and capitalization. This is not a glossary. Here is the [Glossary](/docs/Get-Started/Glossary). +This word list provides an alphabetized list of commonly used terms at Sumo Logic, including components and features of Sumo Logic, and other usage issues, such as punctuation and capitalization. This is not a glossary. Here is the [Glossary](/docs/Get-Started/Glossary). -See the [Style Guide](https://sites.google.com/sumologic.com/ux-sumo-home/design-system/style) provided by our UX team. + ## A @@ -26,8 +22,6 @@ See the [Style Guide](https://sites.google.com/sumologic.com/ux-sumo-home/design **Ampersand (&).** Don't use for "and". Spell out. -**Andre**. Casual user of Sumo who doesn't want to be bothered learning the query language. Wants to troubleshoot then get out of Sumo as fast as possible. - **Anomaly Detection.** Always capitalize. **Apps.** When referring to a Sumo Logic App, capitalize. Otherwise, capitalization is not necessary. No need to spell out application. @@ -35,16 +29,12 @@ See the [Style Guide](https://sites.google.com/sumologic.com/ux-sumo-home/design **Autocomplete.** One word, not two. The Sumo Logic feature is called Search Autocomplete. -## B - -**Bento.** The Sumo UI redesign. Bento is never mentioned to customers. Always say "the new UI". - ## C **Check box.** Check box is two words. Don't use checkbox. -**Classic UI.** Use this term to distinguish the old UI to customers. +**Classic UI.** Use this term to distinguish the old UI. **Click.** You click a UI element. Do not use "click on". @@ -99,13 +89,13 @@ See the [Style Guide](https://sites.google.com/sumologic.com/ux-sumo-home/design ## H -**Hash rules. **Hash rules replace a message with a unique, randomly-generated code to protect sensitive or proprietary information. You may want to hash unique identifiers, such as credit card numbers or user names. By hashing this type of data, you can still track it, even though it's fully hidden. +**Hash rules.** Hash rules replace a message with a unique, randomly-generated code to protect sensitive or proprietary information. You may want to hash unique identifiers, such as credit card numbers or user names. By hashing this type of data, you can still track it, even though it's fully hidden. **Hibachi.** Project for content sharing and collaboration. Includes a new app catalog and app installation flow and a new library design. -**Home Page. **Persistent tab in Bento, which services the Jiro and Hibachi projects by helping Andre get started and discover content more easily. +**Home Page.** Persistent tab, which services the Jiro and Hibachi projects by helping users get started and discover content more easily. -**Hosted Collectors. **Hosted Collectors don't require installation or activation, nor do they have physical requirements, since they're hosted in HTTP Source, an endpoint for receiving a file (or a batch of files) uploaded via a unique URL generated for the Source. The URL securely encodes the Collector and Source information. You can add as many HTTP Sources as you'd like to a single Hosted Collector. +**Hosted Collectors.** Hosted Collectors don't require installation or activation, nor do they have physical requirements, since they're hosted in HTTP Source, an endpoint for receiving a file (or a batch of files) uploaded via a unique URL generated for the Source. The URL securely encodes the Collector and Source information. You can add as many HTTP Sources as you'd like to a single Hosted Collector. ## I @@ -116,19 +106,10 @@ See the [Style Guide](https://sites.google.com/sumologic.com/ux-sumo-home/design **Installed Collector. **Installed Collectors are deployed in your environment, either on a local machine, a machine in your organization, or even an Amazon Machine Image (AMI). Installed Collectors require a software download and installation. Upgrades to Collector software are released regularly by Sumo Logic. - ## J **JavaScript.** Always use camelCase. -**Jiro.** Overall UX initiative to help the Andre persona feel more at home with Sumo. Helping Andre help Andre. Includes parameterized search and home page. - - -## K - -**Kathy. **Manager persona for Sumo. Doesn't use Sumo all that often, so less famous than Melinda and Andre. - - ## L **Library.** The Sumo Logic Library (formerly the Content Library) is now just the Library. Capitalize. @@ -138,12 +119,10 @@ See the [Style Guide](https://sites.google.com/sumologic.com/ux-sumo-home/design ## M -**Markdown. **Used in Text Panels, capitalize Markdown. +**Markdown. **Used in Text Panels. Capitalize Markdown. **MB and Mbit. **MB is the acronym for megabytes. Mbit or Mb is the acronym for megabits. Make sure to capitalize correctly. Don't use a space between the acronym and the number. (Example: 10MB or 15Mbit.) -**Melinda**. Expert/advanced user of Sumo who helps set up her team of Andres and creates content for them. - **Menu.** When referring to a menu in the UI, use the word menu alone. Don't use drop-down menu, list, or selector. **Messages tab.** When referring to the Messages tab (where non-aggregate search results are displayed) the term Messages is capitalized. @@ -169,7 +148,7 @@ See the [Style Guide](https://sites.google.com/sumologic.com/ux-sumo-home/design **Panel.** Formerly called Monitors. Capitalize Panel. -**Please.** Avoid using please. You're making recommendations on how to use software and services, it's not an inconvenience to the user. +**Please.** Avoid using please. You're making recommendations on how to use software and services; it's not an inconvenience to the user. **Plugin.** Plugin is one word, not two, and no hyphen. @@ -219,7 +198,7 @@ Hosted Collectors can use: ## T -**Tabs.** When referring to tabs in the Sumo Logic Web Application, be sure to capitalize each tab's name, but not tab. (Examples: Welcome tab, Search tab, Status tab, Collectors, Users, Account). +**Tabs.** When referring to tabs in Sumo Logic, be sure to capitalize each tab's name, but not tab. (Examples: Welcome tab, Search tab, Status tab, Collectors, Users, Account). **Text box.** Use text box, not field. A field is a special part of a query. @@ -240,17 +219,12 @@ Hosted Collectors can use: **Time zone.** Time zone is two words, not one. -## V - -**Very.** Avoid the word "very" because it doesn't add any additional information to the user. - - ## W **Web Application.** Avoid using where possible. "Sumo" or "our product" should be sufficient. If you need to refer to our web application to distinguish from API, do so. Don't capitalize. **Website.** Website or websites is one word. -**Where operator.** A conditional operator that can precede or follow another operator. Example combinations include "where x matches y", "where x in (a, b, c)", "where x not in (a, b, c)" and "where a > 1 and b / 4 < sqrt(x)". +**Where operator.** A conditional operator that can precede or follow another operator. Example combinations include "where x matches y", "where x in (a, b, c)", "where x not in (a, b, c)" and "where a > 1 and b / 4 < sqrt(x)". **Wildcard.** Wildcard is one word. diff --git a/docs/cse/ingestion/auth0.md b/docs/cse/ingestion/auth0.md index c8cef37c0f..e79752a1d2 100644 --- a/docs/cse/ingestion/auth0.md +++ b/docs/cse/ingestion/auth0.md @@ -29,7 +29,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/aws-application-load-balancer.md b/docs/cse/ingestion/aws-application-load-balancer.md index cbc48718b9..7ce12b5a6e 100644 --- a/docs/cse/ingestion/aws-application-load-balancer.md +++ b/docs/cse/ingestion/aws-application-load-balancer.md @@ -43,7 +43,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an AWS S3 Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select Amazon S3.  diff --git a/docs/cse/ingestion/aws-cloudtrail.md b/docs/cse/ingestion/aws-cloudtrail.md index 524f519b71..1370787383 100644 --- a/docs/cse/ingestion/aws-cloudtrail.md +++ b/docs/cse/ingestion/aws-cloudtrail.md @@ -41,7 +41,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an AWS CloudTrail Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **AWS CloudTrail**.  diff --git a/docs/cse/ingestion/aws-guardduty.md b/docs/cse/ingestion/aws-guardduty.md index 2f83e52dc8..8d10c2b09a 100644 --- a/docs/cse/ingestion/aws-guardduty.md +++ b/docs/cse/ingestion/aws-guardduty.md @@ -32,7 +32,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/aws-network-firewall.md b/docs/cse/ingestion/aws-network-firewall.md index f4f3508e10..f04dcc2d14 100644 --- a/docs/cse/ingestion/aws-network-firewall.md +++ b/docs/cse/ingestion/aws-network-firewall.md @@ -36,7 +36,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an AWS S3 Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select Amazon S3.  diff --git a/docs/cse/ingestion/aws-vpc-flow.md b/docs/cse/ingestion/aws-vpc-flow.md index 3b83f13d3d..8c4d5944ef 100644 --- a/docs/cse/ingestion/aws-vpc-flow.md +++ b/docs/cse/ingestion/aws-vpc-flow.md @@ -42,7 +42,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an AWS S3 Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select Amazon S3.  diff --git a/docs/cse/ingestion/carbon-black.md b/docs/cse/ingestion/carbon-black.md index 571f587de9..62d8c1e9f6 100644 --- a/docs/cse/ingestion/carbon-black.md +++ b/docs/cse/ingestion/carbon-black.md @@ -43,7 +43,7 @@ The bucket you designate for Carbon Black Cloud data must be exclusively used fo 1. [Grant Sumo Logic access](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/Grant-Access-to-an-AWS-Product) to an Amazon S3 bucket. 2. [Enable logging in AWS](http://docs.aws.amazon.com/AmazonS3/latest/dev/enable-logging-console.html) using the Amazon Console. 3. Confirm that logs are being delivered to the Amazon S3 bucket. -4. In the Sumo Logic web app, select **Manage Data > Collection > Collection**. +4. In Sumo Logic, select **Manage Data > Collection > Collection**. 5. Navigate to the Hosted Collector where you want to create the source. 6. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 7. Select **Amazon S3**. diff --git a/docs/cse/ingestion/check-point-firewall.md b/docs/cse/ingestion/check-point-firewall.md index 108af7647c..da089e2d6d 100644 --- a/docs/cse/ingestion/check-point-firewall.md +++ b/docs/cse/ingestion/check-point-firewall.md @@ -37,7 +37,7 @@ In this step, you configure a Syslog Source to collect Check Point Firewall log ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/cisco-asa.md b/docs/cse/ingestion/cisco-asa.md index 7b98461e64..75019af33e 100644 --- a/docs/cse/ingestion/cisco-asa.md +++ b/docs/cse/ingestion/cisco-asa.md @@ -37,7 +37,7 @@ In this step, you configure a Syslog Source to collect Cisco ASA log messages. Y ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/cisco-meraki.md b/docs/cse/ingestion/cisco-meraki.md index 81cef9740d..50023743aa 100644 --- a/docs/cse/ingestion/cisco-meraki.md +++ b/docs/cse/ingestion/cisco-meraki.md @@ -38,7 +38,7 @@ In this step, you configure a Syslog Source to collect Cisco Meraki log messages ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/corelight-zeek.md b/docs/cse/ingestion/corelight-zeek.md index dc3b677388..16c2cfca15 100644 --- a/docs/cse/ingestion/corelight-zeek.md +++ b/docs/cse/ingestion/corelight-zeek.md @@ -38,7 +38,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/fortigate-firewall.md b/docs/cse/ingestion/fortigate-firewall.md index bb28ad799e..6c275b6640 100644 --- a/docs/cse/ingestion/fortigate-firewall.md +++ b/docs/cse/ingestion/fortigate-firewall.md @@ -37,7 +37,7 @@ In this step, you configure a Syslog Source to collect FortiGate log messages. Y ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/g-suite-alert-center.md b/docs/cse/ingestion/g-suite-alert-center.md index 2a54a68ac8..bdb231cca7 100644 --- a/docs/cse/ingestion/g-suite-alert-center.md +++ b/docs/cse/ingestion/g-suite-alert-center.md @@ -29,7 +29,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/google-g-suite-apps-audit.md b/docs/cse/ingestion/google-g-suite-apps-audit.md index d3dd9b3d90..c6515c8429 100644 --- a/docs/cse/ingestion/google-g-suite-apps-audit.md +++ b/docs/cse/ingestion/google-g-suite-apps-audit.md @@ -31,7 +31,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr Each G Suite App must have its own source. Follow these steps for each G Suite App you wish to collect. -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to the Hosted Collector. 1. Select **G Suite Apps Audit.**  diff --git a/docs/cse/ingestion/kemp-loadmaster.md b/docs/cse/ingestion/kemp-loadmaster.md index 5fc09b035c..7e7da036e3 100644 --- a/docs/cse/ingestion/kemp-loadmaster.md +++ b/docs/cse/ingestion/kemp-loadmaster.md @@ -39,7 +39,7 @@ In this step, you configure a Syslog Source to collect Kemp LoadMaster messages. ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/linux-os-syslog.md b/docs/cse/ingestion/linux-os-syslog.md index 784e84b16b..5de5ddc7ba 100644 --- a/docs/cse/ingestion/linux-os-syslog.md +++ b/docs/cse/ingestion/linux-os-syslog.md @@ -62,7 +62,7 @@ In this step, you configure a Syslog Source to collect Linux OS log messages. Yo ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. diff --git a/docs/cse/ingestion/microsoft-audit-office.md b/docs/cse/ingestion/microsoft-audit-office.md index ae5ac53cfd..5430efb4ae 100644 --- a/docs/cse/ingestion/microsoft-audit-office.md +++ b/docs/cse/ingestion/microsoft-audit-office.md @@ -37,7 +37,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr Each Microsoft 365 Content Type must have its own source. Follow these steps for each Microsoft 365 Content Type you wish to collect. -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. Click **Add Source** next to  the Hosted Collector. 1. Select **Office 365 Audit.**  diff --git a/docs/cse/ingestion/microsoft-azure-activity-log.md b/docs/cse/ingestion/microsoft-azure-activity-log.md index 533759b11b..ad50493dd9 100644 --- a/docs/cse/ingestion/microsoft-azure-activity-log.md +++ b/docs/cse/ingestion/microsoft-azure-activity-log.md @@ -31,7 +31,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/microsoft-windows.md b/docs/cse/ingestion/microsoft-windows.md index 933f9fd862..eb089a1bfb 100644 --- a/docs/cse/ingestion/microsoft-windows.md +++ b/docs/cse/ingestion/microsoft-windows.md @@ -31,7 +31,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure a Local Windows Event Log Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. Click **Add Source** next to the Installed Collector. 1. Select **Windows Event Log**.  diff --git a/docs/cse/ingestion/nginx-access-logs.md b/docs/cse/ingestion/nginx-access-logs.md index ea616758b9..982644206c 100644 --- a/docs/cse/ingestion/nginx-access-logs.md +++ b/docs/cse/ingestion/nginx-access-logs.md @@ -41,7 +41,7 @@ If you’re going to use an existing collector, jump to [Configure a Syslog Sour ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/okta.md b/docs/cse/ingestion/okta.md index f43a3517c8..b7c8fde3e3 100644 --- a/docs/cse/ingestion/okta.md +++ b/docs/cse/ingestion/okta.md @@ -29,7 +29,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/onelogin.md b/docs/cse/ingestion/onelogin.md index 95d4c66bfb..321eb73c3e 100644 --- a/docs/cse/ingestion/onelogin.md +++ b/docs/cse/ingestion/onelogin.md @@ -32,7 +32,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/osquery.md b/docs/cse/ingestion/osquery.md index cd7fd86cf8..e0fd01dcc3 100644 --- a/docs/cse/ingestion/osquery.md +++ b/docs/cse/ingestion/osquery.md @@ -43,7 +43,7 @@ It is also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/palo-alto-firewall.md b/docs/cse/ingestion/palo-alto-firewall.md index 5c61535798..f301b4b01f 100644 --- a/docs/cse/ingestion/palo-alto-firewall.md +++ b/docs/cse/ingestion/palo-alto-firewall.md @@ -34,7 +34,7 @@ In this step, you configure a Syslog Source to collect Palo Alto Firewall log me ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/sentinelone.md b/docs/cse/ingestion/sentinelone.md index dc06850109..1b7374c6a5 100644 --- a/docs/cse/ingestion/sentinelone.md +++ b/docs/cse/ingestion/sentinelone.md @@ -29,7 +29,7 @@ In this step, you configure a Cloud Syslog Source to collect SentinelOne log mes ### Configure a Cloud Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to the Hosted Collector. diff --git a/docs/cse/ingestion/signal-sciences-waf.md b/docs/cse/ingestion/signal-sciences-waf.md index 99ad0b26b0..75471c6185 100644 --- a/docs/cse/ingestion/signal-sciences-waf.md +++ b/docs/cse/ingestion/signal-sciences-waf.md @@ -29,7 +29,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/ingestion/symantec-proxy-secure-gateway-blue-coat-proxy.md b/docs/cse/ingestion/symantec-proxy-secure-gateway-blue-coat-proxy.md index 9aed4818e5..6cd0d2fd1b 100644 --- a/docs/cse/ingestion/symantec-proxy-secure-gateway-blue-coat-proxy.md +++ b/docs/cse/ingestion/symantec-proxy-secure-gateway-blue-coat-proxy.md @@ -45,7 +45,7 @@ In this step, you configure a Syslog Source to collect ProxySG log messages. You ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/symantec-proxy-secure-gateway.md b/docs/cse/ingestion/symantec-proxy-secure-gateway.md index 34bd55f902..612b256d82 100644 --- a/docs/cse/ingestion/symantec-proxy-secure-gateway.md +++ b/docs/cse/ingestion/symantec-proxy-secure-gateway.md @@ -50,7 +50,7 @@ In this step, you configure a Syslog Source to collect ProxySG log messages. Yo ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/zscaler-nss.md b/docs/cse/ingestion/zscaler-nss.md index 686ef43e42..dec7b499ac 100644 --- a/docs/cse/ingestion/zscaler-nss.md +++ b/docs/cse/ingestion/zscaler-nss.md @@ -38,7 +38,7 @@ In this step, you configure a Syslog Source to collect ZScaler NSS log messages. ### Configure a Syslog Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Installed Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to an Installed Collector. 1. Select **Syslog**.  diff --git a/docs/cse/ingestion/zscaler-private-access.md b/docs/cse/ingestion/zscaler-private-access.md index 511af0b27d..856920689e 100644 --- a/docs/cse/ingestion/zscaler-private-access.md +++ b/docs/cse/ingestion/zscaler-private-access.md @@ -32,7 +32,7 @@ It’s also possible to configure individual sources to forward to CSE, as descr ### Configure an HTTP Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. Navigate to the Hosted Collector where you want to create the source. 1. On the **Collectors** page, click **Add Source** next to a Hosted Collector. 1. Select **HTTP Logs & Metrics**.  diff --git a/docs/cse/integrations/forward-cse-data-to-sumo.md b/docs/cse/integrations/forward-cse-data-to-sumo.md index 61dd797339..8e68f25060 100644 --- a/docs/cse/integrations/forward-cse-data-to-sumo.md +++ b/docs/cse/integrations/forward-cse-data-to-sumo.md @@ -24,7 +24,7 @@ In this step, you create an HTTP Source on a Hosted Collector on the Sumo Logic To configure an HTTP Source: -1. In the Sumo Logic web app, go to **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, go to **Manage Data \> Collection \> Collection**.  1. On the **Collection** page, find the Host Collector where you want to locate the HTTP Source, and click **Add Source**. 1. On the **Select Source…** page, click **HTTP Logs & Metrics**.  1. The source configuration page appears. diff --git a/docs/cse/integrations/forward-cse-signals-to-sumo.md b/docs/cse/integrations/forward-cse-signals-to-sumo.md index 3cb88fead6..495d128c89 100644 --- a/docs/cse/integrations/forward-cse-signals-to-sumo.md +++ b/docs/cse/integrations/forward-cse-signals-to-sumo.md @@ -28,7 +28,7 @@ In this step, you create an HTTP Source on a Hosted Collector on the Sumo Logic To configure an HTTP Source: -1. In the Sumo Logic web app, go to **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, go to **Manage Data \> Collection \> Collection**.  1. On the **Collection** page, find the Host Collector where you want to locate the HTTP Source, and click **Add Source**. 1. On the **Select Source…** page, click **HTTP Logs & Metrics**.  1. The source configuration page appears. diff --git a/docs/dashboards-new/about-dashboard-new.md b/docs/dashboards-new/about.md similarity index 84% rename from docs/dashboards-new/about-dashboard-new.md rename to docs/dashboards-new/about.md index 9fe1fb28b3..3a807b86fc 100644 --- a/docs/dashboards-new/about-dashboard-new.md +++ b/docs/dashboards-new/about.md @@ -1,6 +1,8 @@ --- -slug: /dashboards-new +id: about title: About Dashboard (New) +sidebar_label: Getting Started +description: Learn the benefits of Dashboard (New) and how it seamlessly integrates log, metric, and trace data. --- import useBaseUrl from '@docusaurus/useBaseUrl'; @@ -56,11 +58,11 @@ Live mode restrictions do not apply to Dashboard (New).  * Auto Refresh applies to the whole dashboard, you can't configure it by panel. * If there are two or more queries in a panel, the refresh interval for the panel is set to the maximum supported interval. -* If the requested refresh interval is not possible, you will get an error message indicating the actual refresh rate is slower than requested. Reasons why the refresh interval is not possible are the following: - - * The time range is too long to refresh at this rate. Reduce the time range to allow a faster refresh interval. - * An operator is not supported at this refresh interval. - * The number of grouped elements is too large for the requested interval. +* Panels with an [absolute time range](../search/get-started-with-search/search-basics/time-range-expressions.md) are not supported. +* If the requested refresh interval is not possible, you'll get an error message indicating the actual refresh rate is slower than requested. This can be due to one of the following reasons: + * The time range is too long to refresh at this rate. Reduce the time range to allow a faster refresh interval. + * An operator is not supported at this refresh interval. + * The number of grouped elements is too large for the requested interval. ## Auto Refresh @@ -72,16 +74,6 @@ A list of the refresh interval rates is provided for you to select from. ![dashboard new refresh interval options.png](/img/dashboards-new/about-dashboard-new/dashboard-new-refresh-interval-options.png) -### Rules - -* Auto Refresh applies to the whole dashboard, individual panels cannot be configured. -* If there are two or more queries in a panel, the refresh interval for the panel is set to the maximum supported interval. -* Panels with an [absolute time range](../search/get-started-with-search/search-basics/time-range-expressions.md) are not supported. -* If the requested refresh interval is not possible, you will get an error message indicating the actual refresh rate is slower than requested. The following are reasons why setting the refresh interval is not possible: - - * The time range is too long to refresh at this rate. Reduce the time range to allow a faster refresh interval. - * An operator is not supported at this refresh interval. - * The number of grouped elements is too large for the requested interval. ## Dark Theme @@ -134,15 +126,6 @@ Dashboards and Dashboard (New). | Dark Theme | Supported | Supported | | Configured Dashboard Linking | Supported | Supported | | Recommended Dashboards & Logs Drilldowns | Not supported | Supported by clicking on data points or slices/sections of pie charts, bar charts, column charts, area charts, and line charts. | -| Combined Metrics & Logs Panel | Not supported | Supported. See how to [overlay logs and metrics in a panel](./dashboard-new-faqs.md#how-do-i-overlay-logs-and-metrics-on-one-panel). | +| Combined Metrics & Logs Panel | Not supported | Supported. See how to [overlay logs and metrics in a panel](./faq#how-do-i-overlay-logs-and-metrics-on-one-panel). | | Styling Queries and Series | Ability to style through settings on the search page.
Can not set color per time series or query.
Restricted ability to override displays. | Ability to style through display overrides inside the panel settings.
Ability to set the color per query/series.
Multiple layers of expressiveness for display overrides.
For details, see how to modify a chart. | | Colors by Value Range | Supported | Not supported | - -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - -## Guide contents - -In this section, we will introduce the following concepts: - - diff --git a/docs/dashboards-new/create_a_dashboard_new.md b/docs/dashboards-new/create-a-dashboard-new.md similarity index 100% rename from docs/dashboards-new/create_a_dashboard_new.md rename to docs/dashboards-new/create-a-dashboard-new.md diff --git a/docs/dashboards-new/explore-view.md b/docs/dashboards-new/explore-view.md index c32ca4491b..757487a23d 100644 --- a/docs/dashboards-new/explore-view.md +++ b/docs/dashboards-new/explore-view.md @@ -24,7 +24,7 @@ Explore can be accessed using Dashboard (New) in conjunction with the below apps ### Stack Linking -Stack linking connects **Dashboard (New)** to Explore so you can view dashboards when exploring infrastructure components. [Learn more](/docs/dashboards-new/link-dashboard-explore.md).
Explore +Stack linking connects **Dashboard (New)** to Explore so you can view dashboards when exploring infrastructure components. [Learn more](/docs/dashboards-new/link-dashboards.md).
Explore ### AWS Observability @@ -111,7 +111,7 @@ The default filter is displayed in the **Filter** drop down menu with a **Defaul ### Obtaining Links -Use the link button to the right of the Dashboard title in Explore to copy the link to your specific entity view in the dashboard. This is related to [Stack Linking](/docs/dashboards-new/link-dashboard-explore.md).
Explore +Use the link button to the right of the Dashboard title in Explore to copy the link to your specific entity view in the dashboard. This is related to [Stack Linking](/docs/dashboards-new/link-dashboards.md).
Explore ### Manually Creating Links diff --git a/docs/dashboards-new/dashboard-new-faqs.md b/docs/dashboards-new/faq.md similarity index 98% rename from docs/dashboards-new/dashboard-new-faqs.md rename to docs/dashboards-new/faq.md index 3b6ecfc79b..6b595f08e9 100644 --- a/docs/dashboards-new/dashboard-new-faqs.md +++ b/docs/dashboards-new/faq.md @@ -1,6 +1,6 @@ --- -id: dashboard-new-faqs -title: Dashboard (New) FAQs +id: faq +title: Dashboard (New) FAQ sidebar_label: FAQ --- @@ -20,7 +20,7 @@ The biggest differences between variables and filters are: 1. Unlike filters, you have to declare variables in your query in order for them to filter the panel. To leverage a variable in a query you can reference it via mustache syntax as follows: - ``` + ```sql {\}} ``` diff --git a/docs/dashboards-new/index.md b/docs/dashboards-new/index.md new file mode 100644 index 0000000000..2d2fbac1f3 --- /dev/null +++ b/docs/dashboards-new/index.md @@ -0,0 +1,15 @@ +--- +slug: /dashboards-new +title: Sumo Logic Dashboard (New) +description: The Dashboard (New) platform allows you to analyze metric and log data on the same dashboard, in a streamlined user experience. +--- + + +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +## Guide contents + +In this section, we will introduce the following concepts: + + diff --git a/docs/dashboards-new/link-dashboard-new.md b/docs/dashboards-new/link-dashboard-new.md deleted file mode 100644 index e1ebea2f79..0000000000 --- a/docs/dashboards-new/link-dashboard-new.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: link-dashboard-new -title: Link Dashboard (New) ---- - -You can link dashboards together to quickly view related data. Each panel can have links to other dashboards. Links have options to include metadata and time range. When you select a data point on -the panel you will have an option to click on linked dashboards. This allows you to quickly reference other related dashboards to investigate.  - -1. Click the **Add Dashboard Link** from the general settings menu when [modifying a chart in a panel](./panels/modify-chart.md). - - ![add link.png](/img/dashboards-new/panels/modify-chart/add-link.png) - -1. Click in the **Dashboard Name** input area and select or enter the name of the dashboard you want the panel to link to. - - * Select to **Include Metadata** if you want the linked dashboard to run against the metadata and variable values of this panel. - * Select to **Include Time Range** if you want the linked dashboard to run with the time range of this panel. - - ![Add dashboard link.png](/img/dashboards-new/panels/modify-chart/Add-dashboard-link.png) - -#### Using links - -When you click a data point on a Dashboard (New) chart the Summary tab provides your Linked Dashboards. - -* The following image shows a Summary panel from a selected log data point. The **Linked Dashboards** section is at the bottom. - - ![summary v2 logs.png](/img/dashboards-new/drill-root-causes/summary-v2-logs.png) - -* The following image shows a Summary panel from a selected metric data point. The **Linked Dashboards** section is at the bottom. - - ![metrics summary v2.png](/img/dashboards-new/drill-root-causes/metrics-summary-v2.png) diff --git a/docs/dashboards-new/link-dashboard-explore.md b/docs/dashboards-new/link-dashboards.md similarity index 62% rename from docs/dashboards-new/link-dashboard-explore.md rename to docs/dashboards-new/link-dashboards.md index 7c7a83e87a..01f82567a6 100644 --- a/docs/dashboards-new/link-dashboard-explore.md +++ b/docs/dashboards-new/link-dashboards.md @@ -1,8 +1,41 @@ --- -id: link-dashboard-to-explore -title: Link a Dashboard (New) to Explore +id: link-dashboards +title: Linking Dashboards (New) --- +## Link Multiple Dashboards Together + +You can link dashboards together to quickly view related data. Each panel can have links to other dashboards. Links have options to include metadata and time range. When you select a data point on +the panel you will have an option to click on linked dashboards. This allows you to quickly reference other related dashboards to investigate.  + +1. Click the **Add Dashboard Link** from the general settings menu when [modifying a chart in a panel](./panels/modify-chart.md). + + ![add link.png](/img/dashboards-new/panels/modify-chart/add-link.png) + +1. Click in the **Dashboard Name** input area and select or enter the name of the dashboard you want the panel to link to. + + * Select to **Include Metadata** if you want the linked dashboard to run against the metadata and variable values of this panel. + * Select to **Include Time Range** if you want the linked dashboard to run with the time range of this panel. + + ![Add dashboard link.png](/img/dashboards-new/panels/modify-chart/Add-dashboard-link.png) + +### Using links + +When you click a data point on a Dashboard (New) chart the Summary tab provides your Linked Dashboards. + +* The following image shows a Summary panel from a selected log data point. The **Linked Dashboards** section is at the bottom. + + ![summary v2 logs.png](/img/dashboards-new/drill-root-causes/summary-v2-logs.png) + +* The following image shows a Summary panel from a selected metric data point. The **Linked Dashboards** section is at the bottom. + + ![metrics summary v2.png](/img/dashboards-new/drill-root-causes/metrics-summary-v2.png) + + + + +## Link a Dashboard (New) to Explore + Stack linking connects Dashboard (New) to Explore so you can view dashboards when exploring infrastructure components. You link a Dashboard (New) to your stack in Explore by specifying metadata key-value pairs: diff --git a/docs/dashboards-new/locate-deviations.md b/docs/dashboards-new/locate-deviations.md index d8df065e93..c5e85eba8b 100644 --- a/docs/dashboards-new/locate-deviations.md +++ b/docs/dashboards-new/locate-deviations.md @@ -52,7 +52,7 @@ To customize the visual appearance of the graph, do the following: ![Outlier_Graph_Display_icon.png](/img/dashboards-new/locate-deviations/Outlier_Graph_Display_icon.png) -1. Make **Format** selections in the right panel as described in [Customizing a chart](create_a_dashboard_new.md). +1. Make **Format** selections in the right panel as described in [Customizing a chart](create-a-dashboard-new.md). ![Chart_Type_Settings.png](/img/dashboards-new/locate-deviations/Chart_Type_Settings.png) diff --git a/docs/dashboards-new/panels.md b/docs/dashboards-new/panels.md index 0f888d56cd..0cd1a1e1c0 100644 --- a/docs/dashboards-new/panels.md +++ b/docs/dashboards-new/panels.md @@ -4,6 +4,10 @@ title: Dashboard (New) Panels sidebar_label: Panels --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + Panels are the building blocks used to create a dashboard. Each panel displays analytics for a specific query. The type of panel you choose to display your data depends on the type of query you want to run. Related topics: @@ -188,7 +192,7 @@ The [Service Map](../apm/traces/working-with-tracing-data/service-map.md) is a h The panel gives you a fully functioning map to zoom in and out and move through services. The size and color of application entities shows status and activity. Click on a service to open the Entity Inspector to drill down to traces, metrics, and the service dashboard. -You can filter the map according to application and service. See the [Dashboard (New)](about-dashboard-new.md) guide for additional information and options to create panels, configure filters, create and filter with template variables from dashboard headers, and more. +You can filter the map according to application and service. See the [Dashboard (New)](about.md) guide for additional information and options to create panels, configure filters, create and filter with template variables from dashboard headers, and more. ![panel-service.png](/img/dashboards-new/panels/panel-service.png) @@ -227,7 +231,7 @@ To add a Service Map panel: Transaction tracing captures and tracks distributed business workflows, by enriching and analyzing traces, logs, and metrics in real-time with automated generated application topology. Each trace provides details on root service, when it occurred and how long, the number of [spans](../apm/traces/working-with-tracing-data/spans.md), and a breakdown of services. The panel panel displays the [Traces page] table to give at-a-glance tracking for traces through your Dashboard. To view transaction and service details, click a trace from the panel to open the [Trace View](../apm/traces/working-with-tracing-data/view-and-investigate-traces.md).  -See the [Dashboard (New)](./about-dashboard-new.md) guide for additional information and options to create panels, configure filters, create and filter with template variables from dashboard headers and more. +See the [Dashboard (New)](./about.md) guide for additional information and options to create panels, configure filters, create and filter with template variables from dashboard headers and more. :::note You are limited to 3 Trace List panels in a dashboard. @@ -291,6 +295,3 @@ You can delete a panel that you no longer need. 1. Select **Delete**. ![delete a panel.png](/img/dashboards-new/panels/delete-panel/delete-a-panel.png) - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; diff --git a/docs/dashboards-new/panels/bubble-charts.md b/docs/dashboards-new/panels/bubble-charts.md index 36ef1f42ee..f5bdbf4921 100644 --- a/docs/dashboards-new/panels/bubble-charts.md +++ b/docs/dashboards-new/panels/bubble-charts.md @@ -4,7 +4,7 @@ id: bubble-charts # Bubble Charts -Bubble charts are available in the [Dashboard (New)](../about-dashboard-new.md) platform. +Bubble charts are available in the [Dashboard (New)](../about.md) platform. Bubble charts display three dimensions of data. A bubble chart is a two dimensional scatter chart where each data point is represented by its size, the third dimension. This allows you to visualize the counts associated with each point. Bubble charts require at least one aggregate dimension and two other numeric dimensions. diff --git a/docs/dashboards-new/panels/scatter-charts.md b/docs/dashboards-new/panels/scatter-charts.md index 4faa35eda5..dc984b1979 100644 --- a/docs/dashboards-new/panels/scatter-charts.md +++ b/docs/dashboards-new/panels/scatter-charts.md @@ -4,7 +4,7 @@ id: scatter-charts # Scatter Charts -Scatter charts are available in the [Dashboard (New)](../about-dashboard-new.md) platform. +Scatter charts are available in the [Dashboard (New)](../about.md) platform. Scatter charts display two independent numeric fields allowing you to see any correlation between them. You can visually determine how your fields relate to and affect one another. diff --git a/docs/dashboards/about-dashboards.md b/docs/dashboards/about.md similarity index 99% rename from docs/dashboards/about-dashboards.md rename to docs/dashboards/about.md index 85bd8a75a0..7e083ac04a 100644 --- a/docs/dashboards/about-dashboards.md +++ b/docs/dashboards/about.md @@ -1,5 +1,5 @@ --- -id: about-dashboards +id: about --- # About Dashboards diff --git a/docs/dashboards/share-dashboard-outside-org.md b/docs/dashboards/share-dashboard-outside-org.md index 72e04c2fd2..5be9b8be31 100644 --- a/docs/dashboards/share-dashboard-outside-org.md +++ b/docs/dashboards/share-dashboard-outside-org.md @@ -13,7 +13,7 @@ This page has information about sharing dashboards with users who do not have a Dashboards often contain sensitive information, so typically you share them only with people within your organization. But sometimes you may want to allow people outside your organization to view a dashboard without logging in, for example if your dashboard is displayed on a monitor in your operations center, or if you want to send an external person a link to a dashboard that reveals a critical problem. :::note -Sharing outside an organization is always view-only and in live mode, and not all [operators are compatible with live mode](restricted-operators-dashboards.md). Also, if this is the first time that live mode is being enabled, it may take some time to backfill the data depending on your queries and timeranges. See [About Dashboards](about-dashboards.md). +Sharing outside an organization is always view-only and in live mode, and not all [operators are compatible with live mode](restricted-operators-dashboards.md). Also, if this is the first time that live mode is being enabled, it may take some time to backfill the data depending on your queries and timeranges. See [About Dashboards](about.md). ::: You can share a dashboard with all external users (“the world”), or with a selected set of external users that you specify in the service allowlist.  @@ -50,7 +50,7 @@ Administrator privileges are required to enable the service allowlist. ## Step 4. Share the dashboard 1. In the left navigation pane, right-click the dashboard you want to share, and click **Share** in the context menu.  - + ![share-option.png](/img/dashboards/share-option.png) 2. The Share Dashboard dialog appears. @@ -71,11 +71,11 @@ If you would like to embed the shared dashboard in a web page, you can get an i 1. Perform the first three substeps of [Step 4](#step-4-share-the-dashboard) above. 2. Click **Embed** in the **Shareable URL** section of the page. - + ![embed-button.png](/img/dashboards/embed-button.png) 3. The HTML for embedding the dashboard in an iframe appears. - + ![iframe-code.png](/img/dashboards/iframe-code.png) 4. Click **Copy** to copy the HTML. @@ -136,7 +136,7 @@ _index=sumologic_audit and _sourceName=REPORT "Viewed Report" _index=sumologic_audit and _sourceName=REPORT "Viewed Report" | parse "Name=*, Id=Some(*)," as dashboardName,dashboardId | parse "URL=*, ViewerIP=*" as url,viewerip -| lookup latitude, longitude from geo://location on ip=viewerip +| lookup latitude, longitude from geo://location on ip=viewerip | count by latitude, longitude | sort _count -``` \ No newline at end of file +``` diff --git a/docs/get-started/account-setup.md b/docs/get-started/account-setup.md index c126158f54..b8d6a9a941 100644 --- a/docs/get-started/account-setup.md +++ b/docs/get-started/account-setup.md @@ -36,7 +36,7 @@ Forgot your password? You can also reset it from the login screen.
Service Status**. -1. Next to the title of a [Dashboard](../dashboards/about-dashboards.md). +1. Next to the title of a [Dashboard](../dashboards/about.md). For more information, click **Help \> Service Status**. This will take you to a web page for your pod with details on any outages, incidents, or planned maintenance. diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 621bc1990e..2d33481d43 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -42,7 +42,7 @@ Sumo Logic is a highly flexible and scalable solution. It provides solutions tha ## Sumo Logic Components -A Collector is a small application that gathers log data from your servers and sends it to the Sumo Logic Cloud. Using the Sumo Logic Web Application, you can interact with and analyze your data in the cloud in real time.
![Collectors M.png](/img/get-started/CollectorsM.png) +A Collector is a small application that gathers log data from your servers and sends it to the Sumo Logic Cloud. Using Sumo Logic, you can interact with and analyze your data in the cloud in real time.
![Collectors M.png](/img/get-started/CollectorsM.png) ### Sumo Logic Collectors and Sources @@ -58,9 +58,9 @@ Sumo Logic [Hosted Collectors](/docs/send-data/hosted-collectors) are hosted  The Sumo Logic Cloud is a secure, scalable repository for all of your operations, security, compliance, development, and other log data. The Sumo Logic Cloud stores, indexes, parses, and analyzes data, and provides unlimited horsepower with elastic scalability. -### Sumo Logic Web Application +### Sumo Logic UI -The Sumo Logic Web Application allows you to view and analyze your log data in the cloud. With a powerful and intuitive search capability, you can use the web application to expedite functions like forensic analysis, troubleshooting, and system health checks. The Sumo Logic Web Application provides access from anywhere since it is fully browser based. It also provides all required administration tools for managing your installation. This includes tools for administration, checking system status, managing your deployment, and direct access to download and activate Collectors. +Sumo Logic allows you to view and analyze your log data in the cloud. With a powerful and intuitive search capability, you can use the web application to expedite functions like forensic analysis, troubleshooting, and system health checks. Sumo Logic provides access from anywhere since it is fully browser based. It also provides all required administration tools for managing your installation. This includes tools for administration, checking system status, managing your deployment, and direct access to download and activate Collectors. ## Data Collection Strategy diff --git a/docs/get-started/sign-up.md b/docs/get-started/sign-up.md index 7cdd353870..6356aad534 100644 --- a/docs/get-started/sign-up.md +++ b/docs/get-started/sign-up.md @@ -170,6 +170,6 @@ If upgrades are allowed for your AWS account, you can upgrade your active accoun To upgrade: -1. Click **Upgrade** on the left navigation pane in the Sumo Logic web app. +1. Click **Upgrade** on the left navigation pane in Sumo Logic. 1. The **Upgrade** button is visible if you have an active AWS account for which upgrades are permitted. 1. On the Upgrade request form, enter Log Ingest level you want to upgrade to. Within 24 to 48 hours, your account will be updated to reflect the change. Once the account is upgraded, the AWS Marketplace will be notified of the change. diff --git a/docs/integrations/amazon-aws/config.md b/docs/integrations/amazon-aws/config.md index 0c697d0292..4f66a8c8ea 100644 --- a/docs/integrations/amazon-aws/config.md +++ b/docs/integrations/amazon-aws/config.md @@ -176,7 +176,7 @@ Panels will start to fill automatically. It's important to note that each panel ## Viewing AWS Config Dashboards -This section describes the dashboards provided by the AWS Config app. For general information about dashboards, see [About Dashboards](/docs/dashboards/about-dashboards.md). +This section describes the dashboards provided by the AWS Config app. For general information about dashboards, see [About Dashboards](/docs/dashboards/about). The AWS Config app is an older application, implemented when Sumo dashboards could not be toggled back and forth between Live and Interactive mode. For this reason, the app provides two versions of the AWS Config Overview dashboard, one that runs in Live mode, and one that runs in Interactive mode. diff --git a/docs/integrations/cloud-security-monitoring-analytics/aws-cloudtrail-pci-compliance.md b/docs/integrations/cloud-security-monitoring-analytics/aws-cloudtrail-pci-compliance.md index bf3480f834..e3346084cf 100644 --- a/docs/integrations/cloud-security-monitoring-analytics/aws-cloudtrail-pci-compliance.md +++ b/docs/integrations/cloud-security-monitoring-analytics/aws-cloudtrail-pci-compliance.md @@ -78,7 +78,7 @@ Once you begin uploading data, your daily data usage will increase. It's a good _sourceCategory=AWS_EAGLE (*Security* OR *Network*) | parse "\"userName\":\"*\"" as user | parse "\"eventName\":\"*\"" as event -| parse regex field=event "^(?<event_type>[A-Z][a-z]+?)[A-Z]" +| parse regex field=event "^(?[A-Z][a-z]+?)[A-Z]" | where (event matches "*Security*" OR event matches "*Network*") and event_type in ("Create","Delete") | count by event | sort _count diff --git a/docs/integrations/cloud-security-monitoring-analytics/linux.md b/docs/integrations/cloud-security-monitoring-analytics/linux.md index 1bbbea970d..0d04209379 100644 --- a/docs/integrations/cloud-security-monitoring-analytics/linux.md +++ b/docs/integrations/cloud-security-monitoring-analytics/linux.md @@ -263,7 +263,7 @@ sudo systemctl daemon-reload -2. **Remove the collector from the Sumo Logic Web Application**: +2. **Remove the collector from Sumo Logic**: 1. In Sumo Logic select **Manage Data > Collection > Collection**. 2. Find the collector you want to remove, and click **Delete**. 3. When the Confirm dialog displays, click **OK**. diff --git a/docs/integrations/containers-orchestration/docker-enterprise-edition.md b/docs/integrations/containers-orchestration/docker-enterprise-edition.md index 0d4f1c79a9..f47eb74027 100644 --- a/docs/integrations/containers-orchestration/docker-enterprise-edition.md +++ b/docs/integrations/containers-orchestration/docker-enterprise-edition.md @@ -52,7 +52,7 @@ The Docker EE App uses the following log types. Universal Control Plane (UCP) - E0509 02:44:15.887502 1 goroutinemap.go:150] Operation for "provision-default/orcl-pv-claim[4e38340b-6866-11e9-95b6-0242ac11000a]" failed. No retries permitted until 2019-05-09 02:46:17.887477418 +0000 UTC m=+453713.589406681 (durationBeforeRetry 2m2s). Error: "AzureDisk - failed to get Azure Cloud Provider. GetCloudProvider returned <nil> instead" + E0509 02:44:15.887502 1 goroutinemap.go:150] Operation for "provision-default/orcl-pv-claim[4e38340b-6866-11e9-95b6-0242ac11000a]" failed. No retries permitted until 2019-05-09 02:46:17.887477418 +0000 UTC m=+453713.589406681 (durationBeforeRetry 2m2s). Error: "AzureDisk - failed to get Azure Cloud Provider. GetCloudProvider returned nil instead" diff --git a/docs/integrations/microsoft-azure/iis-7.md b/docs/integrations/microsoft-azure/iis-7.md index 0ac34258bc..efffccb8a7 100644 --- a/docs/integrations/microsoft-azure/iis-7.md +++ b/docs/integrations/microsoft-azure/iis-7.md @@ -173,9 +173,9 @@ After a few minutes, your new Source should be propagated down to the Collector * **Scope**: Use the source category set above, such as "IIS_prod" * **Parse Expression:** ``` -parse regex "^[^#].*?(?<s_ip>\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) (?<cs_method>\S+?) -(?<cs_uri_stem>\S+?) (?<cs_uri_query>\S+?) (?<s_port>\d+?) (?<cs_username>\S+?) -(?<c_ip>.+?) (?<cs_User_Agent>\S+?) (?<cs_Referer>\S+?) (?<sc_status>\d+?) +parse regex "^[^#].*?(?\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) (?\S+?) +(?\S+?) (?\S+?) (?\d+?) (?\S+?) +(?.+?) (?\S+?) (?\S+?) (?\d+?) (?\d+?) (?\d+?) (?\d+?)$" ``` diff --git a/docs/manage/collection/upgrade-collectors.md b/docs/manage/collection/upgrade-collectors.md index 491dc15d90..49eee2ff57 100644 --- a/docs/manage/collection/upgrade-collectors.md +++ b/docs/manage/collection/upgrade-collectors.md @@ -6,7 +6,7 @@ title: Upgrade Collectors ## Upgrade Collectors using the Web Application -Deploying an upgrade to one or more collectors can be done through the Sumo Logic Web Application. When you initiate a collector upgrade, the installed collector downloads the upgrade package directly from the Sumo +Deploying an upgrade to one or more collectors can be done through Sumo Logic. When you initiate a collector upgrade, the installed collector downloads the upgrade package directly from the Sumo Logic service. We recommend you follow our [best practices](#collector-upgrade-best-practices) when you upgrade your Collectors. You can also downgrade a collector to a previous version, as described in this topic. @@ -58,7 +58,7 @@ You can choose to downgrade a Collector or Collectors to an earlier version for To downgrade one or more collectors to an earlier build: -1. In the Sumo Logic Web Application select **Manage Data \> Collection \> Collection**. +1. In Sumo Logic select **Manage Data \> Collection \> Collection**. 1. Click the **Edit** link on the right of an installed collector. 1. Click the **Change Version** beside the current version. 1. Select the version to install.  diff --git a/docs/manage/manage-subscription/cloud-flex-accounts.md b/docs/manage/manage-subscription/cloud-flex-accounts.md index a80677493c..39dc14188a 100644 --- a/docs/manage/manage-subscription/cloud-flex-accounts.md +++ b/docs/manage/manage-subscription/cloud-flex-accounts.md @@ -95,8 +95,8 @@ Using a Free account is a great way to get to know Sumo Logic. While you're try * If you begin to reach the 500 MB daily limit, Sumo Logic sends an email to let you know. You can take action to [reduce the amount of data](../partitions-and-data-tiers/manage-indexes-variable-retention.md) you're uploading in order to stay below the limit. * If the 500 MB limit is surpassed, you'll receive an email letting you know that data in the Sumo Logic Cloud can no longer be searched (but additional data is still collected). However, if the data limit is fully exceeded, data collection stops (in addition to search being disabled). Disabled features will be available after your usage falls below 4 GB when averaged over seven days (this could take one day, or up to seven days, depending on the amount of data you've uploaded and where you've uploaded it). * In extreme situations, Free accounts may be disabled if the data volume continues to exceed the limits. -* Free accounts are limited to 20 continuous queries, including [Dashboard Panels](../../dashboards/about-dashboards.md). -* Because Free accounts run on seven-day intervals, [Dashboard Panel](../../dashboards/about-dashboards.md) queries may not use a time range longer than seven days. +* Free accounts are limited to 20 continuous queries, including [Dashboard Panels](/docs/dashboards/about). +* Because Free accounts run on seven-day intervals, [Dashboard Panel](/docs/dashboards/about) queries may not use a time range longer than seven days. * For Sumo Logic Apps, Free accounts are limited to install the [Log Analysis QuickStart app](/docs/get-started/sumo-logic-apps#log-analysis-quickstart-app). * The limitations of a Free account can't be changed, but you can upgrade to a Professional account at any time. * For information on throttling and account caps, see [Manage Ingestion](../ingestion-and-volume/log-ingestion.md). diff --git a/docs/manage/scheduled-views/pause-disable-scheduled-views.md b/docs/manage/scheduled-views/pause-disable-scheduled-views.md index a0dc11c518..d592e6018e 100644 --- a/docs/manage/scheduled-views/pause-disable-scheduled-views.md +++ b/docs/manage/scheduled-views/pause-disable-scheduled-views.md @@ -17,7 +17,7 @@ To resume indexing at a later time, click **Start**. Once disabled, no additional data can be indexed in a scheduled view. A disabled scheduled view is not technically deleted, but it can't be re-enabled. If you disable a view and later create a new view with the same name, you won't see duplicate results; instead all the data from both scheduled views are treated as one. -If you disable a view, it is no longer visible in the Sumo Logic web application. If you create a new view with that same name, any query spanning the time range where both (the old and the new scheduled view) exist will search the union of the two scheduled views. +If you disable a view, it is no longer visible in Sumo Logic. If you create a new view with that same name, any query spanning the time range where both (the old and the new scheduled view) exist will search the union of the two scheduled views. To disable a scheduled view: diff --git a/docs/manage/security/access-keys.md b/docs/manage/security/access-keys.md index bc541c0833..273cf173c5 100644 --- a/docs/manage/security/access-keys.md +++ b/docs/manage/security/access-keys.md @@ -46,7 +46,7 @@ If you have the **Create Access Keys** role capability, you can use the **Prefer To create your own access keys: -1. In the Sumo Logic web app, click your name in the left-nav and open the **Preferences** page. +1. In Sumo Logic, click your name in the left-nav and open the **Preferences** page. 1. In the **My Access Keys** section, click **+ Add Access Key**. ![access-key-preferences-page-2.png](/img/security/access-key-preferences-page-2.png) diff --git a/docs/manage/security/saml/integrate-onelogin.md b/docs/manage/security/saml/integrate-onelogin.md index d4d647a7de..72baa25a16 100644 --- a/docs/manage/security/saml/integrate-onelogin.md +++ b/docs/manage/security/saml/integrate-onelogin.md @@ -84,7 +84,7 @@ This section has instructions for configuring SAML in Sumo Logic. 1. **Issuer**. Paste in the **Issuer URL** you copied from the OneLogin **SSO** page, as described above. 1. **X.509 Certificate**. Paste in the certificate you downloaded from the OneLogin **SSO** page, as described above.  1. **Attribute mapping**. Select "Use SAML subject". -1. **SP-initiated Login**. (Optional) This configuration enables a Sumo user to initiate login from the Sumo Logic web app. To configure this option, see [Configure SP-initiated login](#configure-sp-initiated-login). +1. **SP-initiated Login**. (Optional) This configuration enables a Sumo user to initiate login from Sumo Logic. To configure this option, see [Configure SP-initiated login](#configure-sp-initiated-login). 1. **Roles Attribute**. (Optional). To configure this option, see [Configure on-demand role provisioning](#configure-on-demand-role-provisioning). 1. **On Demand Provisioning**. (Optional). See [Configure on demand provisioning](#configure-on-demand-account-provisioning) below. v**Logout Page**. When a Sumo user logs out of Sumo Logic or if the user’s session times out, they will be redirected to the page you specify. If you want users to be redirected to your OneLogin portal page, enter `https``://your-domain.onelogin.com/portal/` where `your-domain` is your company's OneLogin domain. @@ -115,7 +115,7 @@ features. SP initiated login requires a custom Sumo Logic subdomain. If a custom subdomain has not yet been configured for your org, following the instructions in the [Change account subdomain](docs/manage/manage-subscription/manage-org-settings.md) section of the *Manage Organization* topic. ::: -This configuration enables a Sumo user to initiate login from the Sumo Logic web app. Sumo redirects the user to OneLogin with a SAML AuthnRequest with the  information that OneLogin needs to authenticate the user. OneLogin replies to Sumo with a SAML Assertion (SAMLResponse).  +This configuration enables a Sumo user to initiate login from Sumo Logic. Sumo redirects the user to OneLogin with a SAML AuthnRequest with the  information that OneLogin needs to authenticate the user. OneLogin replies to Sumo with a SAML Assertion (SAMLResponse).  1. **Authn Request URL**. Enter the **SAML 2.0 Endpoint URL** that you copied from the OneLogin **SSO** page, as described above.  1. **Disable Requested Authentication Context**. (Optional). Leave unchecked. diff --git a/docs/manage/users-and-roles/index.md b/docs/manage/users-and-roles/index.md index 39e311b64f..bfff9b843c 100644 --- a/docs/manage/users-and-roles/index.md +++ b/docs/manage/users-and-roles/index.md @@ -5,7 +5,7 @@ title: Users and Roles These topics have information about creating and managing Sumo Logic roles and users. In Sumo Logic, an administrator controls access to capabilities and data by assigning capabilities and search filters to roles, and then assigning user to roles. For more information see [Role-Based Access Control](roles/role-based-access-control.md). -In the Sumo Logic web app, you'll find pages for managing users and roles at **Administration** \> **Users and Roles**. +In Sumo Logic, you'll find pages for managing users and roles at **Administration** \> **Users and Roles**. :::note To manage users and roles, you must have the Administrator role or your role must have been assigned the [manage users and roles capability](roles/role-capabilities.md). diff --git a/docs/manage/users-and-roles/roles/index.md b/docs/manage/users-and-roles/roles/index.md index 41fdab4e01..ca394c89e2 100644 --- a/docs/manage/users-and-roles/roles/index.md +++ b/docs/manage/users-and-roles/roles/index.md @@ -10,7 +10,7 @@ This guide has information about creating and managing Sumo Logic roles. In Sumo To manage users and roles, you must have the administrator role or your role must have been assigned the [manage users and roles capability](role-capabilities.md). ::: -In the Sumo Logic web app, you'll find pages for managing roles at **Administration \> Users and Roles \> Roles**. +In Sumo Logic, you'll find pages for managing roles at **Administration \> Users and Roles \> Roles**. import DocCardList from '@theme/DocCardList'; import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; diff --git a/docs/manage/users-and-roles/users/index.md b/docs/manage/users-and-roles/users/index.md index 1c6996b34b..4434bbb099 100644 --- a/docs/manage/users-and-roles/users/index.md +++ b/docs/manage/users-and-roles/users/index.md @@ -9,7 +9,7 @@ This guide has information about how to create and manage Sumo Logic Users. In To manage users and roles, you must have the administrator role or your role must have been assigned the [manage users and roles capability](../roles/role-capabilities.md). ::: -In the Sumo Logic web app, you'll find pages for managing users at **Administration** \> **Users and Roles** \> **Users**. +In Sumo Logic, you'll find pages for managing users at **Administration** \> **Users and Roles** \> **Users**. import DocCardList from '@theme/DocCardList'; import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; diff --git a/docs/metrics/metric-queries-alerts/engine-updates.md b/docs/metrics/metric-queries-alerts/engine-updates.md index d1c36174cb..ff7e3f540f 100644 --- a/docs/metrics/metric-queries-alerts/engine-updates.md +++ b/docs/metrics/metric-queries-alerts/engine-updates.md @@ -90,7 +90,7 @@ The Sumo Logic metric query language supports the following reducer functions: ` Queries that meet all the following conditions will be affected by this change. -* Don’t contain an explicit `quantize using <agg>` statement (where `<agg>` is a quantization method). +* Don’t contain an explicit `quantize using ` statement (where `` is a quantization method). * Do contain a reducer function that uses at least one of these aggregation functions: `min`, `max`, `sum`, `count`. * The quantization used on the selector level (implicitly or explicitly) is less granular than the reporting interval. Of course, it depends on the underlying data, but typically, the quantization must be bigger than 1 minute so that a query can be affected. @@ -111,7 +111,7 @@ The query results that appear on the chart view are based upon quantizing the da We use `avg` as the quantization method: -* if the query does not contain using `<agg>` (because `avg` is the default when method is not specified), or +* if the query does not contain using `` (because `avg` is the default when method is not specified), or * if the query does contain `using avg`. If another quantization method is explicitly specified in the query, for example `using sum`, we use that method. diff --git a/docs/observability/kubernetes/quickstart.md b/docs/observability/kubernetes/quickstart.md index cbcfe73697..66bfc2d185 100644 --- a/docs/observability/kubernetes/quickstart.md +++ b/docs/observability/kubernetes/quickstart.md @@ -107,4 +107,4 @@ You will have to install other K8s-related apps depending upon whether you want * [Full List of Configuration Options](https://github.com/SumoLogic/sumologic-kubernetes-collection/tree/main/deploy/helm/sumologic#configuration) * [Share a Dashboard (New)](/docs/dashboards-new/share-dashboard-new.md) -* [Link a dashboard to Explore](/docs/dashboards-new/link-dashboard-explore.md) +* [Link a dashboard to Explore](/docs/dashboards-new/link-dashboards.md) diff --git a/docs/releasenotes/cloud-siem.md b/docs/releasenotes/cloud-siem.md index e1e1d1b0f5..1cb6960058 100644 --- a/docs/releasenotes/cloud-siem.md +++ b/docs/releasenotes/cloud-siem.md @@ -1095,8 +1095,8 @@ We will be consolidating Authentication Brute Force Attempt **MATCH-S00258** on #### Minor Changes and Enhancements -* [New] API endpoints are now available to add or remove a given Signal to/from a given Insight, PUT "/insights/<insightId>/signals" and DELETE "/insights/<insightId>/signals" respectively. (For both endpoints, the request body is a list containing signal ID(s) to add or remove from the insight as the request body, the response is the updated Insight.) -* [Update] The way CSE displays group membership in Active Directory inventory objects is changing. Previously, it was displayed in LDAP form (i.e. cn=groupname,dc=something,dc=domain,dc=com); now it will just show the group name. +* [New] API endpoints are now available to add or remove a given Signal to/from a given Insight, `PUT "/insights//signals"` and `DELETE "/insights//signals"` respectively. (For both endpoints, the request body is a list containing signal ID(s) to add or remove from the insight as the request body, the response is the updated Insight.) +* [Update] The way CSE displays group membership in Active Directory inventory objects is changing. Previously, it was displayed in LDAP form (i.e., `cn=groupname,dc=something,dc=domain,dc=com`); now it will just show the group name. #### Resolved Issues diff --git a/docs/search/live-tail/live-tail-cli.md b/docs/search/live-tail/live-tail-cli.md index 66a4f9ee3b..c6977ac39f 100644 --- a/docs/search/live-tail/live-tail-cli.md +++ b/docs/search/live-tail/live-tail-cli.md @@ -14,7 +14,7 @@ The Live Tail CLI supports the following operating systems: ## Limitations -The limitations for the Live Tail CLI are the same as the [Live Tail](about-live-tail.md) feature in the Sumo Logic Web Application, but for these exceptions: +The limitations for the Live Tail CLI are the same as the [Live Tail](about-live-tail.md) feature in Sumo Logic, but for these exceptions: * You can tail logs ingested from Sources configured on Installed Collectors and from HTTP and Cloud Syslog Sources on Hosted Collectors. @@ -54,7 +54,7 @@ The metadata field and filter must be enclosed in quotes. ### Search -With the Live Tail CLI, just as with [Live Tail](about-live-tail.md) in the Sumo Logic Web Application, you can search with the following metadata fields: +With the Live Tail CLI, just as with [Live Tail](about-live-tail.md) in Sumo Logic, you can search with the following metadata fields: * `_sourceCategory` * `_sourceHost` diff --git a/docs/search/search-query-language/search-operators/dedup.md b/docs/search/search-query-language/search-operators/dedup.md index 2d99f0d8f9..c2e5beec73 100644 --- a/docs/search/search-query-language/search-operators/dedup.md +++ b/docs/search/search-query-language/search-operators/dedup.md @@ -12,7 +12,7 @@ For example, to find the most recent value of services you'd use the following o The operator is supported in the following features: * [Log Search](/docs/search) -* [Dashboards (New)](../../../dashboards-new/about-dashboard-new.md) +* [Dashboards (New)](../../../dashboards-new/about.md) * [Dashboards](/docs/dashboards), including live mode * [Scheduled Searches](../../../alerts/scheduled-searches/schedule-search.md) diff --git a/docs/send-data/collect-from-other-data-sources/collect-logs-sentinelone.md b/docs/send-data/collect-from-other-data-sources/collect-logs-sentinelone.md index 8e6ebedc6e..77ca823214 100644 --- a/docs/send-data/collect-from-other-data-sources/collect-logs-sentinelone.md +++ b/docs/send-data/collect-from-other-data-sources/collect-logs-sentinelone.md @@ -61,7 +61,7 @@ To configure syslog messages, do the following: 1. Click **Test**, and then click **Save**. -1. In the Sumo Logic Web Application, verify that the logs are being ingested by running a search against the Cloud Syslog source you configured in [Step 1](#step-1-get-a-token-and-certificate-from-sumo-logic). If you don't see any data coming in after 2-3 minutes, check the following: +1. In Sumo Logic, verify that the logs are being ingested by running a search against the Cloud Syslog source you configured in [Step 1](#step-1-get-a-token-and-certificate-from-sumo-logic). If you don't see any data coming in after 2-3 minutes, check the following: * that the Sumo Logic Collector has read access to the logs * that your time zone is configured correctly. diff --git a/docs/send-data/collect-from-other-data-sources/collect-ruby-on-rails-logs.md b/docs/send-data/collect-from-other-data-sources/collect-ruby-on-rails-logs.md index f8161d466e..4f5b4a715c 100644 --- a/docs/send-data/collect-from-other-data-sources/collect-ruby-on-rails-logs.md +++ b/docs/send-data/collect-from-other-data-sources/collect-ruby-on-rails-logs.md @@ -31,7 +31,7 @@ and the multiline setup. 1. Click **Save**.  -1. In the Sumo Logic Web Application, go to **Manage Data \> Collection \> Status** to verify that the logs are being ingested. If you don't see any data coming in after 2-3 minutes, check that your file path is correct, that the Sumo Logic Collector has read access to the logs, and that your time zone is configured correctly. +1. In Sumo Logic, go to **Manage Data \> Collection \> Status** to verify that the logs are being ingested. If you don't see any data coming in after 2-3 minutes, check that your file path is correct, that the Sumo Logic Collector has read access to the logs, and that your time zone is configured correctly. ## Parsing RoR Logs diff --git a/docs/send-data/collector-faq.md b/docs/send-data/collector-faq.md index 61ff154c3a..ac5f6b8ad2 100644 --- a/docs/send-data/collector-faq.md +++ b/docs/send-data/collector-faq.md @@ -543,7 +543,7 @@ For both searches above, it’s a good idea to use a relative time range that lo After installing a Collector and configuring a Source, your data should appear in Sumo Logic in a matter of minutes. How can you confirm that your data is being collected? Try any of the following options.  -#### Check the Status page of the Sumo Logic Web Application +#### Check the Status page of Sumo Logic In Sumo Logic select **Manage Data \> Collection \> Status** to view the total message volume (the volume of all Collectors in your account) and the volume of data from each Collector. diff --git a/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-logs-source.md b/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-logs-source.md index 560043cfbf..6281c57a96 100644 --- a/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-logs-source.md +++ b/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-logs-source.md @@ -21,7 +21,7 @@ When you create an AWS Kinesis Firehose for Logs Source, you add it to a Hosted To create an AWS Kinesis Firehose for Logs Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted** **Collector. 1. Select **AWS Kinesis Firehose for Logs Source**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/1password-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/1password-source.md index 2d87344ed2..1fc859c94b 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/1password-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/1password-source.md @@ -67,7 +67,7 @@ When you create a 1Password Source, you add it to a Hosted Collector. Before cre To configure a 1Password Source: -1. In the Sumo Logic web app, select** Manage Data > Collection > Collection**. +1. In Sumo Logic, select** Manage Data > Collection > Collection**. 2. On the Collectors page, click **Add Source** next to a Hosted** **Collector. 3. Select **1Password**. 4. Enter a **Name **for the Source. The **description** is optional. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/akamai-siem-api-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/akamai-siem-api-source.md index 305b5d4459..4cbb9d0b8a 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/akamai-siem-api-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/akamai-siem-api-source.md @@ -47,7 +47,7 @@ When you create an Akamai SIEM API Source, you add it to a Hosted Collector. Be To configure an Akamai SIEM API Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collection page, click **Add Source** next to a HostedCollector. 1. Select **Akamai SIEM API**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/azure-event-hubs-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/azure-event-hubs-source.md index 1ba1693853..8b186815ed 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/azure-event-hubs-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/azure-event-hubs-source.md @@ -102,7 +102,7 @@ When you create an Azure Event Hubs Source, you add it to a Hosted Collector. Be To configure an Azure Event Hubs Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**. +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**. 1. On the Collectors page, click **Add Source** next to a **HostedCollector**. 1. Select **Azure Event Hubs**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/box-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/box-source.md index b60338d12c..07e8780375 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/box-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/box-source.md @@ -53,7 +53,7 @@ Hover your mouse over the status icon to view a tooltip with details on the dete When you create a Box Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Create a Hosted Collector](https://help.sumologic.com/03Send-Data/Hosted-Collectors#Create_a_Hosted_Collector). To configure a Box Source: -1. In the Sumo Logic web app, navigate to** Manage Data > Collection** and open the **Collection** tab. +1. In Sumo Logic, navigate to** Manage Data > Collection** and open the **Collection** tab. 2. On the Collectors page, click **Add Source** next to a Hosted Collector. 3. Select **Box**.
Box 4. Enter a **Name** for the Source. The **description** is optional.
Box diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-cloud-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-cloud-source.md index c77a959fbd..17c23b0708 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-cloud-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-cloud-source.md @@ -58,7 +58,7 @@ When you create a Carbon Black Cloud Source, you add it to a Hosted Collector. To configure A Carbon Black Cloud Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a **Hosted Collector**. 1. Select **Carbon Black Cloud**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-inventory-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-inventory-source.md index faba244c1d..ea1a8eac7f 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-inventory-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-inventory-source.md @@ -43,7 +43,7 @@ When you create a Carbon Black Inventory Source, you add it to a Hosted Collect To configure A Carbon Black Inventory Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collection page, click **Add Source** next to a Hosted Collector. 1. Select **Carbon Black Inventory**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-amp-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-amp-source.md index 1a0409dc09..18e8272dc6 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-amp-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-amp-source.md @@ -43,7 +43,7 @@ When you create a Cisco AMP Source, you add it to a Hosted Collector. Before cr To configure a Cisco AMP Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a HostedCollector. 1. Select **Cisco AMP**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-fdr-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-fdr-source.md index bf5896d2d2..6c21ce556f 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-fdr-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-fdr-source.md @@ -54,7 +54,7 @@ When you create a CrowdStrike FDR Source, you add it to a Hosted Collector. Bef To configure a CrowdStrike FDR Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-source.md index b93eeaebb6..b2936edffb 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-source.md @@ -62,7 +62,7 @@ When you create a CrowdStrike Source, you add it to a Hosted Collector. Before To configure a CrowdStrike Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cse-aws-ec-inventory-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cse-aws-ec-inventory-source.md index 6434412105..a5973a3dce 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cse-aws-ec-inventory-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cse-aws-ec-inventory-source.md @@ -47,7 +47,7 @@ When you create a CSE AWS EC2 Inventory Source, you add it to a Hosted Collecto To configure a CSE AWS EC2 Inventory Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collection page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cybereason-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cybereason-source.md index b602c774f1..5ebcfb6751 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cybereason-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cybereason-source.md @@ -50,7 +50,7 @@ When you create a Cybereason Source, you add it to a Hosted Collector. Before c To configure a Cybereason Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cylance-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cylance-source.md index a0f5577a79..1441ecea6f 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cylance-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cylance-source.md @@ -49,7 +49,7 @@ When you create a Cylance Source, you add it to a Hosted Collector. Before creat To configure a Cylance Source: -1. In the Sumo Logic web app, select** Manage Data > Collection > Collection**. +1. In Sumo Logic, select** Manage Data > Collection > Collection**. 1. On the Collectors page, click **Add Source** next to a Hosted** **Collector. 1. Select **Cylance**. 1. Enter a **Name **for the Source. The description is optional. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/dropbox-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/dropbox-source.md index a45c32631a..719f65b562 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/dropbox-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/dropbox-source.md @@ -64,7 +64,7 @@ When you create a Dropbox Source, you add it to a Hosted Collector. Before crea To configure a **Dropbox Source -1. In the Sumo Logic web app, navigate to** Manage Data \> Collection** and open the **Collection** tab.  +1. In Sumo Logic, navigate to** Manage Data \> Collection** and open the **Collection** tab.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **Dropbox**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/duo-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/duo-source.md index 68d03957dd..6687149758 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/duo-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/duo-source.md @@ -49,7 +49,7 @@ When you create a Duo Source, you add it to a Hosted Collector. Before creating To configure a Duo Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **Duo**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/google-workspace-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/google-workspace-source.md index 6ce0cf5568..f0c82d5e27 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/google-workspace-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/google-workspace-source.md @@ -59,7 +59,7 @@ When you create a Google Workspace Source, you add it to a Hosted Collector. Be To configure a Google Workspace Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **Google Workspace**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-azure-ad-inventory-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-azure-ad-inventory-source.md index 63245ffcd2..857bedfd96 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-azure-ad-inventory-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-azure-ad-inventory-source.md @@ -100,7 +100,7 @@ When you create a Microsoft Azure AD Inventory Source, you add it to a Hosted C To configure a Microsoft Azure AD Inventory Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-graph-security-api-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-graph-security-api-source.md index 8d11204dd0..5d993bacc6 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-graph-security-api-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/microsoft-graph-security-api-source.md @@ -85,7 +85,7 @@ When you create a Microsoft Graph Security API Source, you add it to a Hosted C To configure a Microsoft Graph Security API Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/mimecast-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/mimecast-source.md index 6e1f2e1d32..b4efcb12d3 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/mimecast-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/mimecast-source.md @@ -61,7 +61,7 @@ When you create a Mimecast Source, you add it to a Hosted Collector. Before cre To configure a Mimecast Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-azure-ad-reporting-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-azure-ad-reporting-source.md index 6d29328f6d..f2ae0d2e61 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-azure-ad-reporting-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-azure-ad-reporting-source.md @@ -93,7 +93,7 @@ When you create a Microsoft Graph Azure AD Reporting Source, you add it to a Ho To configure a Microsoft Graph Azure AD Reporting Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**. +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**. 1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **MS Graph Azure AD Reporting**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-identity-protection-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-identity-protection-source.md index 805202e89b..286dc2cb7c 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-identity-protection-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/ms-graph-identity-protection-source.md @@ -88,7 +88,7 @@ When you create a Microsoft Graph Identity Protection Source, you add it to a H To configure a Microsoft Graph Identity Protection Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-source.md index 08ec84c6f8..dc34dbd768 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-source.md @@ -63,7 +63,7 @@ When you create a Netskope Source, you add it to a Hosted Collector. Before cre To configure A Netskope Source -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **Netskope**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-webtx.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-webtx.md index b744d280ea..92efa35aeb 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-webtx.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/netskope-webtx.md @@ -49,7 +49,7 @@ When you create an Netskope WebTx API Source, you add it to a Hosted Collector. **To configure an Netskope WebTx API Source:** -1. In the Sumo Logic web app, select** Manage Data > Collection > Collection**. +1. In Sumo Logic, select** Manage Data > Collection > Collection**. 1. On the Collection page, click **Add Source** next to a Hosted** **Collector. 1. Select **Netskope WebTx API**. 1. Enter a **Name** to display the Source in the Sumo web application. The description is optional. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/okta-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/okta-source.md index f917093228..61ae76eeb0 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/okta-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/okta-source.md @@ -51,7 +51,7 @@ When you create an Okta Source, you add it to a Hosted Collector. Before creatin To configure an Okta Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **Okta**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/palo-alto-cortex-xdr-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/palo-alto-cortex-xdr-source.md index a812b543c2..1c0ba45a66 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/palo-alto-cortex-xdr-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/palo-alto-cortex-xdr-source.md @@ -47,7 +47,7 @@ When you create a Palo Alto Cortex XDR Source, you add it to a Hosted Collector To configure a Palo Alto Cortex XDR Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **Palo Alto Cortex XDR**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-on-demand-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-on-demand-source.md index 5f5d0d0e86..75999cffcc 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-on-demand-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-on-demand-source.md @@ -58,7 +58,7 @@ When you create a Proofpoint On Demand Source, you add it to a Hosted Collecto To configure a Proofpoint On Demand Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-tap-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-tap-source.md index 20121ed364..8172c3539c 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-tap-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/proofpoint-tap-source.md @@ -190,7 +190,7 @@ When you create a Proofpoint TAP Source, you add it to a Hosted Collector. Befo To configure a Proofpoint TAP Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sailpoint-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sailpoint-source.md index 52293030a6..c666fc13c1 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sailpoint-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sailpoint-source.md @@ -70,7 +70,7 @@ When you create a SailPoint Source, you add it to a Hosted Collector. Before cr To configure a Duo Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. 1. Select **SailPoint**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/salesforce-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/salesforce-source.md index 6272c758d2..0e73c2c566 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/salesforce-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/salesforce-source.md @@ -49,7 +49,7 @@ When you create a Salesforce Source, you add it to a Hosted Collector. Before To configure a Salesforce Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a HostedCollector. 1. Select **Salesforce**. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sentinelone-mgmt-api-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sentinelone-mgmt-api-source.md index 190e9fee56..4dca91e6c5 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sentinelone-mgmt-api-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sentinelone-mgmt-api-source.md @@ -73,7 +73,7 @@ When you create a SentinelOne Mgmt API Source, you add it to a Hosted Collector To configure a SentinelOne Mgmt API Source:** -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sophos-central-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sophos-central-source.md index 6f88a29d2f..63b0193238 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sophos-central-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sophos-central-source.md @@ -56,7 +56,7 @@ When you create a Sophos Central Source, you add it to a Hosted Collector. Befo To configure a Sophos Central Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-web-security-service-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-web-security-service-source.md index 46304cbb45..df3f7b7508 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-web-security-service-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-web-security-service-source.md @@ -70,7 +70,7 @@ When you create a Symantec Web Security Service Source, you add it to a Hosted To configure a Symantec Web Security Service Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/tenable-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/tenable-source.md index 9e00cc307f..55b4ed2474 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/tenable-source.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/tenable-source.md @@ -51,7 +51,7 @@ When you create a Tenable Source, you add it to a Hosted Collector. Before crea To configure A Tenable Source: -1. In the Sumo Logic web app, navigate to** Manage Data \> Collection** and open the **Collection** tab. +1. In Sumo Logic, navigate to** Manage Data \> Collection** and open the **Collection** tab. 1. On the Collectors page, click **Add Source** next to a Hosted Collector. diff --git a/docs/send-data/hosted-collectors/http-source/logs-metrics.md b/docs/send-data/hosted-collectors/http-source/logs-metrics.md index 63c6b12466..6d5cffcc46 100644 --- a/docs/send-data/hosted-collectors/http-source/logs-metrics.md +++ b/docs/send-data/hosted-collectors/http-source/logs-metrics.md @@ -21,7 +21,7 @@ As a best practice, Sumo Logic recommends batching data into each POST request t To configure an HTTP Logs and Metrics Source: -1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.  +1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.  1. In the Collectors page, click **Add Source** next to a Hosted** **Collector. 1. Select **HTTP Logs & Metrics**.  1. Enter a **Name** to display for the Source in the Sumo web application. Description is optional. diff --git a/docs/send-data/hosted-collectors/index.md b/docs/send-data/hosted-collectors/index.md index d43070eca9..989b5b1af9 100644 --- a/docs/send-data/hosted-collectors/index.md +++ b/docs/send-data/hosted-collectors/index.md @@ -15,7 +15,7 @@ Data collection flow for S3 buckets and HTTP requests: ![team built hosted diagram.png](/img/send-data/team-built-hosted-diagram.png) -Just as Installed Collectors, you can monitor the activity of Hosted Collectors using the Status tab of the Sumo Logic Web Application. +Just as Installed Collectors, you can monitor the activity of Hosted Collectors using the Status tab. :::note The maximum number of Collectors allowed per organization is 10,000. diff --git a/docs/send-data/installed-collectors/collector-installation-reference/binary-package-install-a-collector.md b/docs/send-data/installed-collectors/collector-installation-reference/binary-package-install-a-collector.md index f48fbb0bd8..b34b31b23d 100644 --- a/docs/send-data/installed-collectors/collector-installation-reference/binary-package-install-a-collector.md +++ b/docs/send-data/installed-collectors/collector-installation-reference/binary-package-install-a-collector.md @@ -16,7 +16,7 @@ Before you begin: * Install the version of JRE you want to use. The binary installation process does not include JRE installation. Download the JRE here: \  * Download the binary file from either of these locations: - * Sumo Logic web application: **Manage Collection \> Collection \> Collection \> Add Collector \> Installed Collector \> Install a Binary Package** + * **Manage Collection \> Collection \> Collection \> Add Collector \> Installed Collector \> Install a Binary Package** * Static download link: https://collectors.sumologic.com/rest/download/tar ## Prepare the binary file @@ -44,7 +44,7 @@ Before you begin: The Collector Management API allows you to pass all Source settings in a JSON file, including Source name, metadata tags, and pointer to the files you want to collect. For instructions, see [Using JSON to configure Sources](/docs/send-data/use-json-configure-sources). -Optionally, you can configure Source using the Sumo Logic Web Application after the Collector has been installed. +Optionally, you can configure Source using Sumo Logic after the Collector has been installed. ## (Optional) Enable FIPS diff --git a/docs/send-data/installed-collectors/linux.md b/docs/send-data/installed-collectors/linux.md index 21e670cb4f..f347608e22 100644 --- a/docs/send-data/installed-collectors/linux.md +++ b/docs/send-data/installed-collectors/linux.md @@ -250,7 +250,7 @@ Uninstalling a collector requires the following two steps: * [RPM/Debian package](#uninstall-using-the-rpm-or-debian-package) * [Binary package](#uninstall-using-the-binary-package) -1. [Remove the collector from the Sumo Logic Web Application](#remove-the-collector-from-the-web-app) +1. [Remove the collector from Sumo Logic](#remove-the-collector-from-the-web-app) ### Uninstall using the UI Installer diff --git a/docs/send-data/installed-collectors/macos.md b/docs/send-data/installed-collectors/macos.md index 590078d1a6..75016c88ab 100644 --- a/docs/send-data/installed-collectors/macos.md +++ b/docs/send-data/installed-collectors/macos.md @@ -101,7 +101,7 @@ Uninstalling a Sumo Logic installed Collector requires the following steps: * [Uninstall using the installer](#uninstall-using-the-installer) * [Uninstall from the command line](#uninstall-from-the-command-line) -1. [Remove the Collector from the Sumo Logic Web Application](#delete-the-collector-from-the-web-application). +1. [Remove the Collector from Sumo Logic](#delete-the-collector-from-the-web-application). ### Uninstall using the installer diff --git a/docs/send-data/installed-collectors/sources/collect-forwarded-events-windows-event-collector.md b/docs/send-data/installed-collectors/sources/collect-forwarded-events-windows-event-collector.md index be3a5bae77..0b91ca864b 100644 --- a/docs/send-data/installed-collectors/sources/collect-forwarded-events-windows-event-collector.md +++ b/docs/send-data/installed-collectors/sources/collect-forwarded-events-windows-event-collector.md @@ -39,7 +39,7 @@ To configure a Windows Event Log Source: ![type of windows event log source.png](/img/send-data/windows-event-log-source.png) -1. Set the following: * **Name.** Type the name you'd like to display for this source in the Sumo Logic Web Application.  +1. Set the following: * **Name.** Type the name you'd like to display for this source in Sumo Logic.  * **Description.** Optional description. * **Windows host(s).** **(Remote Source only)**Enter one or more hostnames for the Windows machines from which you want to collect Windows Events. If you'd like to collect from more than one remote host, separate the hostnames with a comma. (If you enter more than one hostname, each host must allow event log access from the same domain user. See the [prerequisites](preconfigure-machine-collect-remote-windows-events.md) for more information.) The hostname can be a maximum of 128 characters. The hostname values are parsed and applied to your event logs as \_sourceHost [metadata](remote-windows-event-log-source.md) automatically. The value is parsed from the field `Computer` in your event logs. diff --git a/docs/send-data/installed-collectors/sources/remote-file-source/prerequisites-windows-remote-file-collection.md b/docs/send-data/installed-collectors/sources/remote-file-source/prerequisites-windows-remote-file-collection.md index 3f95c882cd..e2c83d277e 100644 --- a/docs/send-data/installed-collectors/sources/remote-file-source/prerequisites-windows-remote-file-collection.md +++ b/docs/send-data/installed-collectors/sources/remote-file-source/prerequisites-windows-remote-file-collection.md @@ -43,12 +43,12 @@ where files reside. ![img](/img/send-data/Win-UNC-share-permissions-sm.png) -1. Click **OK**. When the Permissions dialog closes, you will see your UNC path listed under Network Path. This is the exact path you will enter when you are configuring a Local File Source in the Sumo Logic Web Application. +1. Click **OK**. When the Permissions dialog closes, you will see your UNC path listed under Network Path. This is the exact path you will enter when you are configuring a Local File Source in Sumo Logic. ![img](/img/send-data/Win-UNC-path.png) 1. Verify that you have set up the share correctly. Open Explorer on the machine where the Collector is installed. Type in the UNC share path. If you can see the log files listed, you can collect them. If Explorer asks you to enter a password, then you have not set up permissions correctly. Make sure that permissions for the folder are set to "Everyone" and "Read-Only." -1. From the Sumo Logic Web Application, [create a new Local File Source](../local-file-source.md). +1. From Sumo Logic, [create a new Local File Source](../local-file-source.md). 1. Enter the file path to the UNC share. For this example, the UNC path looks like this:  **\\\\WIN-QR0406514NE\\LogFiles** In general, a UNC path has this format: **\\\\server\\share\\file_path**. diff --git a/docs/send-data/installed-collectors/sources/remote-windows-event-log-source.md b/docs/send-data/installed-collectors/sources/remote-windows-event-log-source.md index 0db387eeee..94f9beaaee 100644 --- a/docs/send-data/installed-collectors/sources/remote-windows-event-log-source.md +++ b/docs/send-data/installed-collectors/sources/remote-windows-event-log-source.md @@ -34,7 +34,7 @@ To configure a remote Windows Event Log Source: 1. Set the following: - * **Name.** Type the name you'd like to display for this source in the Sumo Logic Web Application.  + * **Name.** Type the name you'd like to display for this source in Sumo Logic.  * **Description.** Optional description. * **Windows host(s).** Enter one or more hostnames for the Windows machines from which you want to collect Windows Events. If you'd like to collect from more than one remote host, separate the hostnames with a comma. (If you enter more than one hostname, each host must allow event log access from the same domain user. See the [prerequisites](preconfigure-machine-collect-remote-windows-events.md) for more information.) The hostname can be a maximum of 128 characters. The hostname values are parsed and applied to your event logs as \_sourceHost metadata automatically. The value is parsed from the field `Computer` in your event logs. * **Source Category.** Enter a string to tag the logs collected from this Source with searchable metadata. For example, typing **web_apps** tags all the logs from this Source in the sourceCategory field. For more information, see [Metadata Naming Conventions](docs/send-data/reference-information/metadata-naming-conventions.md) and our [Best Practices: Good and Bad Source Categories](/docs/send-data/best-practices#good-and-bad-source-categories). You can define a Source Category value using system environment variables, see [Configuring sourceCategory using variables](#configuring-sourcecategory-using-variables) below. diff --git a/docs/send-data/installed-collectors/windows.md b/docs/send-data/installed-collectors/windows.md index 2cc6a1a2f3..d1b7f2d6eb 100644 --- a/docs/send-data/installed-collectors/windows.md +++ b/docs/send-data/installed-collectors/windows.md @@ -105,7 +105,7 @@ Uninstalling a Sumo Logic installed Collector requires the following steps: * [Uninstall using the installer](#uninstall-using-the-installer) * [Uninstall from the command line](#uninstall-from-the-command-line) -1. [Remove the Collector from the Sumo Logic Web Application](#remove-the-collector-from-the-web-application) +1. [Remove the Collector from Sumo Logic](#remove-the-collector-from-the-web-application) ### Uninstall using the installer diff --git a/docs/send-data/setup-wizard.md b/docs/send-data/setup-wizard.md index e463dafdce..eae55e0aec 100644 --- a/docs/send-data/setup-wizard.md +++ b/docs/send-data/setup-wizard.md @@ -23,7 +23,7 @@ Keyboard shortcuts are not available when the Setup Wizard is open. A great way to try out Sumo Logic for the first time is to upload a local log file. To do this, click **Upload Log Files**. You can upload up to 20 files and 100MB total per upload. -Uploading a local file allows you to try Sumo Logic without configuring a Collector to ingest live, streaming data. To continuously monitor a file in your environment, [configure a Collector and Source](https://help.sumologic.com/03Send-Data/01-Design-Your-Deployment) within the Sumo Logic Web Application. +Uploading a local file allows you to try Sumo Logic without configuring a Collector to ingest live, streaming data. To continuously monitor a file in your environment, [configure a Collector and Source](https://help.sumologic.com/03Send-Data/01-Design-Your-Deployment) within Sumo Logic. The following file types are **not** supported: diff --git a/docs/send-data/use-json-configure-sources/index.md b/docs/send-data/use-json-configure-sources/index.md index daf34f6dd6..5bc86186ff 100644 --- a/docs/send-data/use-json-configure-sources/index.md +++ b/docs/send-data/use-json-configure-sources/index.md @@ -166,7 +166,7 @@ The following parameters are automatically configured by the Sumo Logic Servic ## Time zone format -In a JSON source configuration, a string for the `timeZone` setting does not follow the same format as the time zone setting shown in the Sumo Logic Web Application. The JSON `timeZone` property uses the underlying TZ database time zone format instead of (GMT+11:00) style values. +In a JSON source configuration, a string for the `timeZone` setting does not follow the same format as the time zone setting shown in Sumo Logic. The JSON `timeZone` property uses the underlying TZ database time zone format instead of (GMT+11:00) style values. Example: diff --git a/docusaurus.config.js b/docusaurus.config.js index 5476d3c73f..1d87d93f7e 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -119,7 +119,7 @@ module.exports = { redirects: [ { //CID REDIRECTS: Enter a from: of the /cid=##### with the path to the file for to: for each CID! - to: '/docs/contributing/markdown-features', + to: '/docs/contributing/markdown-cheat-sheet', from: '/cid=1234', }, ] diff --git a/sidebars.ts b/sidebars.ts index c9ab3f5e64..b04737158e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -728,18 +728,17 @@ module.exports = { type: 'category', label: 'Dashboards (New)', collapsible: true, - collapsed: true, - link: {type: 'doc', id: 'dashboards-new/about-dashboard-new'}, + collapsed: false, + link: {type: 'doc', id: 'dashboards-new/index'}, items: [ + 'dashboards-new/about', 'dashboards-new/create-a-dashboard-new', - 'dashboards-new/dashboard-new-faqs', + 'dashboards-new/faq', 'dashboards-new/drill-down-to-discover-root-causes', 'dashboards-new/export-dashboard-new', + 'dashboards-new/link-dashboards', 'dashboards-new/filter-template-variables', 'dashboards-new/explore-view', - 'dashboards-new/link-dashboard-to-explore', - 'dashboards-new/link-dashboard-new', - 'dashboards-new/locate-deviations-time-series', { type: 'category', label: 'Panels', @@ -763,6 +762,7 @@ module.exports = { 'dashboards-new/panels/table-charts', ], }, + 'dashboards-new/locate-deviations-time-series', 'dashboards-new/set-custom-time-ranges', 'dashboards-new/share-a-dashboard-new', ], @@ -774,7 +774,7 @@ module.exports = { collapsed: true, link: {type: 'doc', id: 'dashboards/index'}, items: [ - 'dashboards/about-dashboards', + 'dashboards/about', { type: 'category', label: 'Get Started', @@ -2108,8 +2108,9 @@ module.exports = { link: {type: 'doc', id: 'contributing/index'}, items: [ 'contributing/create-document', - 'contributing/markdown-features', + 'contributing/markdown-cheat-sheet', 'contributing/style-guide', + 'contributing/word-list', 'contributing/code-of-conduct', 'get-started/glossary', 'contributing/translations', From 57fef39af3c24bed5bc79790aa998963d30a98de Mon Sep 17 00:00:00 2001 From: Kim <56411016+kimsauce@users.noreply.github.com> Date: Tue, 20 Sep 2022 00:28:26 -0700 Subject: [PATCH 3/3] dashboards metadata --- docs/dashboards-new/create-a-dashboard-new.md | 1 + .../drill-down-to-discover-root-causes.md | 1 + docs/dashboards-new/explore-view.md | 1 + docs/dashboards-new/export-dashboard-new.md | 1 + docs/dashboards-new/faq.md | 1 + .../filter-with-template-variables.md | 1 + docs/dashboards-new/link-dashboards.md | 1 + docs/dashboards-new/locate-deviations.md | 1 + docs/dashboards-new/panels.md | 1 + docs/dashboards-new/panels/area-charts.md | 9 +++++---- docs/dashboards-new/panels/bar-charts.md | 4 ++-- docs/dashboards-new/panels/box-plot-charts.md | 3 +-- docs/dashboards-new/panels/bubble-charts.md | 12 +++++++----- docs/dashboards-new/panels/column-charts.md | 4 +++- docs/dashboards-new/panels/combo-charts.md | 12 +++++++----- docs/dashboards-new/panels/line-charts.md | 4 +++- docs/dashboards-new/panels/map-charts.md | 17 +++++++++-------- docs/dashboards-new/panels/markdown-syntax.md | 4 +++- docs/dashboards-new/panels/modify-chart.md | 4 +++- docs/dashboards-new/panels/pie-charts.md | 4 +++- docs/dashboards-new/panels/scatter-charts.md | 8 +++++--- .../panels/single-value-charts.md | 8 ++++---- docs/dashboards-new/panels/table-charts.md | 9 +++++---- docs/dashboards-new/set-custom-time-ranges.md | 1 + docs/dashboards-new/share-dashboard-new.md | 1 + 25 files changed, 71 insertions(+), 42 deletions(-) diff --git a/docs/dashboards-new/create-a-dashboard-new.md b/docs/dashboards-new/create-a-dashboard-new.md index 5c186890db..0f28ad4e6f 100644 --- a/docs/dashboards-new/create-a-dashboard-new.md +++ b/docs/dashboards-new/create-a-dashboard-new.md @@ -1,6 +1,7 @@ --- id: create-a-dashboard-new title: Create a Dashboard (New) +description: Learn how to create your own custom Dashboard (New) with a panel and query, then customize a chart and add the chart to the dashboard. --- This page demonstrates how to create a Dashboard (New), add a query, and then add the chart to the dashboard. You create your Dashboard (New) by selecting template options from menus and drop-downs. diff --git a/docs/dashboards-new/drill-down-to-discover-root-causes.md b/docs/dashboards-new/drill-down-to-discover-root-causes.md index 8732dd73c6..e95090546a 100644 --- a/docs/dashboards-new/drill-down-to-discover-root-causes.md +++ b/docs/dashboards-new/drill-down-to-discover-root-causes.md @@ -1,6 +1,7 @@ --- id: drill-down-to-discover-root-causes title: Drill Down to Discover Root Causes +description: Learn how to drill into related content to discover the root cause of a spike of interest on a dashboard. --- When you see a spike of interest on a dashboard that requires further investigation, you can easily drill into the related content to discover the root cause. This page shows you how you can easily discover related dashboards and corresponding logs searches that pertain to an issue in your environment. diff --git a/docs/dashboards-new/explore-view.md b/docs/dashboards-new/explore-view.md index 757487a23d..b85174e9bf 100644 --- a/docs/dashboards-new/explore-view.md +++ b/docs/dashboards-new/explore-view.md @@ -2,6 +2,7 @@ id: explore-view title: Navigating Sumo Logic Dashboards with Explore sidebar_label: Explore View +description: Explore gives you an easy way to view and navigate the hierarchy of your environment. --- import Iframe from 'react-iframe'; diff --git a/docs/dashboards-new/export-dashboard-new.md b/docs/dashboards-new/export-dashboard-new.md index 4f5c20bef7..ff013c914d 100644 --- a/docs/dashboards-new/export-dashboard-new.md +++ b/docs/dashboards-new/export-dashboard-new.md @@ -2,6 +2,7 @@ id: export-dashboard-new title: Exporting Sumo Logic Dashboards (New) sidebar_label: Export Dashboard (New) +description: Learn how to export your Dashboard (New) as a PDF or PNG file. --- Dashboards provide insights for monitoring key performance indicators (KPIs) across your organization. There may be times when key stakeholders require access to a static snapshot of dashboard KPIs without having to log in to Sumo Logic. In these instances, you can export a snapshot of a dashboard to share. This capability allows you to extend monitoring analytics to a broader base both within and outside your organization. diff --git a/docs/dashboards-new/faq.md b/docs/dashboards-new/faq.md index 6b595f08e9..61ed200f5a 100644 --- a/docs/dashboards-new/faq.md +++ b/docs/dashboards-new/faq.md @@ -2,6 +2,7 @@ id: faq title: Dashboard (New) FAQ sidebar_label: FAQ +description: Find answers to frequently asked questions about our new Dashboards. --- ## How do I convert a Classic Dashboard to the new dashboard framework? diff --git a/docs/dashboards-new/filter-with-template-variables.md b/docs/dashboards-new/filter-with-template-variables.md index 0cd2745ae7..e1f2e58fab 100644 --- a/docs/dashboards-new/filter-with-template-variables.md +++ b/docs/dashboards-new/filter-with-template-variables.md @@ -2,6 +2,7 @@ id: filter-template-variables title: Filtering Dashboards (New) with Template Variables sidebar_label: Filtering with Template Variables +description: Learn how to use template variables to dynamically filter dashboard data. --- Template variables are a feature of Dashboard (New) that allow you to analyze specific data on demand. They give you the ability to filter the data displayed on your dashboard so you can quickly troubleshoot a problem. Queries can be changed on the fly by choosing values for variables from drop-down lists without having to manually edit queries. diff --git a/docs/dashboards-new/link-dashboards.md b/docs/dashboards-new/link-dashboards.md index 01f82567a6..eefab065be 100644 --- a/docs/dashboards-new/link-dashboards.md +++ b/docs/dashboards-new/link-dashboards.md @@ -1,6 +1,7 @@ --- id: link-dashboards title: Linking Dashboards (New) +description: Easily link dashboards together to quickly view related data. --- ## Link Multiple Dashboards Together diff --git a/docs/dashboards-new/locate-deviations.md b/docs/dashboards-new/locate-deviations.md index c5e85eba8b..83b7159a99 100644 --- a/docs/dashboards-new/locate-deviations.md +++ b/docs/dashboards-new/locate-deviations.md @@ -1,6 +1,7 @@ --- id: locate-deviations-time-series title: Locate Deviations in a Time Series +description: Learn how to create charts that locate deviations in a time series and the graph outliers. --- An **outlier** is a data point that is outside the range of expected values. This page shows you how to locate deviations beyond thresholds in a time series.  diff --git a/docs/dashboards-new/panels.md b/docs/dashboards-new/panels.md index 0cd1a1e1c0..18e0e5007d 100644 --- a/docs/dashboards-new/panels.md +++ b/docs/dashboards-new/panels.md @@ -2,6 +2,7 @@ id: panels title: Dashboard (New) Panels sidebar_label: Panels +description: Learn about the different panel types available in Dashboard (New) and the types of data best suited for each. --- import Tabs from '@theme/Tabs'; diff --git a/docs/dashboards-new/panels/area-charts.md b/docs/dashboards-new/panels/area-charts.md index bdba42abff..69f90df8c7 100644 --- a/docs/dashboards-new/panels/area-charts.md +++ b/docs/dashboards-new/panels/area-charts.md @@ -1,9 +1,10 @@ --- id: area-charts -description: An area chart is used to visually represent quantity over a period of time. +title: Area Charts +description: An area chart is used to visually represent quantity over a period of time. --- -# Area Charts + An area chart is used to visually represent quantity over a period of time. The quantity is laid out on the vertical axis, and the horizontal axis shows the time period being charted. What distinguishes an area chart from a line chart is the use of shaded regions below the line which better indicates the increase or decrease of volume. @@ -24,14 +25,14 @@ which would produce results such as: To add a panel with an area chart: 1. Create or open a Dashboard (New) and click on **Add Panel \> Time Series** or **Add Panel \> Categorical**. - + ![time series or categorical.png](/img/dashboards-new/panels/area-charts/time-series-or-categorical.png) 1. Provide a Metric or Log query and press **Enter** for it to run. 1. Once the query runs you will need to flip the chart type to **Area**. ![Dashboard New Area Chart.png](/img/dashboards-new/panels/area-charts/Dashboard-New-Area-Chart.png) - + 1. [Modify the chart](./modify-chart.md) as desired. 1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. diff --git a/docs/dashboards-new/panels/bar-charts.md b/docs/dashboards-new/panels/bar-charts.md index 5ad4403665..93e2805196 100644 --- a/docs/dashboards-new/panels/bar-charts.md +++ b/docs/dashboards-new/panels/bar-charts.md @@ -1,9 +1,9 @@ --- id: bar-charts +title: Bar Charts description: Bar charts are useful for visually comparing the number of events that have occurred. --- -# Bar Charts Bar charts are useful for visually comparing the number of events that have occurred, such as the type of error that occurs the most in your system. To create a Bar chart, use a search query that provides at least a few data points in the **Aggregates** tab. @@ -33,5 +33,5 @@ To add a panel with a bar chart: 1. [Modify the chart](./modify-chart.md) as desired. 1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. - + ![Add to Dashboard button.png](/img/dashboards-new/create-dashboard-new/Add-to-Dashboard-button.png) diff --git a/docs/dashboards-new/panels/box-plot-charts.md b/docs/dashboards-new/panels/box-plot-charts.md index 2e38116504..68bec217e1 100644 --- a/docs/dashboards-new/panels/box-plot-charts.md +++ b/docs/dashboards-new/panels/box-plot-charts.md @@ -1,10 +1,9 @@ --- id: box-plot-charts +title: Box Plot Charts description: Box Plot Chart graphically depicts groups of data using quartiles, which are the values that divide a list of numbers into quarters. --- -# Box Plot Charts - A Box Plot Chart graphically depicts groups of data using quartiles, which are the values that divide a list of numbers into quarters. In Box Plot charts, the bottom and top of the box represent the first and third quartiles; the band inside the box represents the median. ![Box plot](/img/dashboards-new/panels/box-plot-charts/Box-plot.png) diff --git a/docs/dashboards-new/panels/bubble-charts.md b/docs/dashboards-new/panels/bubble-charts.md index f5bdbf4921..45d6c64e31 100644 --- a/docs/dashboards-new/panels/bubble-charts.md +++ b/docs/dashboards-new/panels/bubble-charts.md @@ -1,8 +1,10 @@ --- id: bubble-charts +title: Bubble Charts +description: Bubble charts show you the size of data points in relation to two other dimensions. --- -# Bubble Charts + Bubble charts are available in the [Dashboard (New)](../about.md) platform. @@ -17,9 +19,9 @@ You can modify the fields used for each axis as needed. For example, in the following query `logins` is the Z dimension and will be displayed as the value of each bubble. The fields `latitude` and `longitude` can be used as dimensions. ```sql -_sourceCategory=service "message=User logged in" remote_ip -| parse "[remote_ip=*]" as remote_ip -| lookup latitude, longitude, city, state from geo://location on ip = remote_ip +_sourceCategory=service "message=User logged in" remote_ip +| parse "[remote_ip=*]" as remote_ip +| lookup latitude, longitude, city, state from geo://location on ip = remote_ip | count as logins by city, latitude, longitude ``` @@ -47,5 +49,5 @@ To add a panel with a bubble chart: ![Add to Dashboard button.png](/img/dashboards-new/create-dashboard-new/Add-to-Dashboard-button.png) - +   diff --git a/docs/dashboards-new/panels/column-charts.md b/docs/dashboards-new/panels/column-charts.md index 19446dc975..aee2864c6a 100644 --- a/docs/dashboards-new/panels/column-charts.md +++ b/docs/dashboards-new/panels/column-charts.md @@ -1,8 +1,10 @@ --- id: column-charts +title: Column Charts +description: Column charts are useful for visually comparing the number of events that have occurred. --- -# Column Charts + Column charts are useful for visually comparing the number of events that have occurred, such as the type of error that occurs the most in your system. To create a Column chart, use a search query that provides at least a few data points in the **Aggregates** tab. diff --git a/docs/dashboards-new/panels/combo-charts.md b/docs/dashboards-new/panels/combo-charts.md index b6f5d8bc93..0b2f0b6969 100644 --- a/docs/dashboards-new/panels/combo-charts.md +++ b/docs/dashboards-new/panels/combo-charts.md @@ -1,17 +1,19 @@ --- id: combo-charts +title: Combo Charts +description: Column charts are useful for visually comparing the number of events that have occurred. --- -# Combo Charts + Combo charts have a secondary vertical axis allowing you to view two aggregates on the same chart. A common combo chart is a bar or column chart with a secondary vertical axis as a separate line as a comparison. For example, say we're running a query like: -```sql -_sourceCategory=*apache* -| parse "HTTP/1.1\" * * * " as status_code, size, referrer -| timeslice 5m +``` +_sourceCategory=*apache* +| parse "HTTP/1.1\" * * * " as status_code, size, referrer +| timeslice 5m | avg(size), count by _timeslice ``` diff --git a/docs/dashboards-new/panels/line-charts.md b/docs/dashboards-new/panels/line-charts.md index 048d60a454..3b465b0876 100644 --- a/docs/dashboards-new/panels/line-charts.md +++ b/docs/dashboards-new/panels/line-charts.md @@ -1,8 +1,10 @@ --- id: line-charts +title: Line Charts +description: Line charts are useful for displaying how data changes over time. --- -# Line Charts + Line charts are useful for displaying how data changes over time, where the Y axis of a line chart displays the count of an item, and the X axis is a timeline. diff --git a/docs/dashboards-new/panels/map-charts.md b/docs/dashboards-new/panels/map-charts.md index d006ba0c36..15a2e363ac 100644 --- a/docs/dashboards-new/panels/map-charts.md +++ b/docs/dashboards-new/panels/map-charts.md @@ -1,8 +1,9 @@ --- id: map-charts +title: Map Charts +description: Map charts are useful for showing IP addresses from log messages on a map. --- -# Map Charts Map charts show the location and number of hits from data on a map. @@ -14,19 +15,19 @@ To map your data you can:  For example, you'd use the geoip operator to create a map chart: ```sql -| parse "remote_ip=*]" as client_ip -| geoip client_ip -| count by latitude, longitude +| parse "remote_ip=*]" as client_ip +| geoip client_ip +| count by latitude, longitude | sort _count ``` Or, you'd use the geo lookup operator to create a map chart: ```sql -_sourceCategory=Error -| parse regex "(\\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})" -| lookup latitude, longitude, country_code, country_name, region, city, postal_code from geo://location on ip = client_ip -| count by latitude, longitude, country_code, country_name, region, city, postal_code +_sourceCategory=Error +| parse regex "(\\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})" +| lookup latitude, longitude, country_code, country_name, region, city, postal_code from geo://location on ip = client_ip +| count by latitude, longitude, country_code, country_name, region, city, postal_code | sort _count ``` diff --git a/docs/dashboards-new/panels/markdown-syntax.md b/docs/dashboards-new/panels/markdown-syntax.md index a57ece27d6..5ea1f68569 100644 --- a/docs/dashboards-new/panels/markdown-syntax.md +++ b/docs/dashboards-new/panels/markdown-syntax.md @@ -1,8 +1,10 @@ --- id: markdown-syntax +title: Markdown Syntax +description: Markdown Syntax options are supported in Dashboards. --- -# Markdown Syntax + The following Markdown Syntax options are supported in Dashboards. When your syntax is supported, you will see "Markdown Supported" near the bottom left corner of the text box. Unsupported syntax prevents you from clicking the **Submit** button. diff --git a/docs/dashboards-new/panels/modify-chart.md b/docs/dashboards-new/panels/modify-chart.md index 940966d982..2c0d2a30c7 100644 --- a/docs/dashboards-new/panels/modify-chart.md +++ b/docs/dashboards-new/panels/modify-chart.md @@ -1,8 +1,10 @@ --- id: modify-chart +title: Modify a Chart +description: Learn how to customize a chart's type and visual display characteristics. --- -# Modify a Chart + You can customize a chart on a dashboard panel in a variety of ways. You can even change the chart type to analyze the data in another format. This section shows you how to customize a chart or change the chart type entirely.  diff --git a/docs/dashboards-new/panels/pie-charts.md b/docs/dashboards-new/panels/pie-charts.md index 42e1ccdea0..5a606f0628 100644 --- a/docs/dashboards-new/panels/pie-charts.md +++ b/docs/dashboards-new/panels/pie-charts.md @@ -1,8 +1,10 @@ --- id: pie-charts +title: Pie Charts +description: Donut or Pie charts are useful for visually comparing the percentage of events that have occurred for a particular field. --- -# Pie Charts + Pie charts are useful for visually comparing the percentage of events that have occurred, such as the type of error that occurs the most in your system. A pie chart will compare different values for the same field. If you want to compare values for different fields consider using a histogram. diff --git a/docs/dashboards-new/panels/scatter-charts.md b/docs/dashboards-new/panels/scatter-charts.md index dc984b1979..617ed1071c 100644 --- a/docs/dashboards-new/panels/scatter-charts.md +++ b/docs/dashboards-new/panels/scatter-charts.md @@ -1,8 +1,10 @@ --- id: scatter-charts +title: Scatter Charts +description: Scatter charts show correlations between two fields against specific data. --- -# Scatter Charts + Scatter charts are available in the [Dashboard (New)](../about.md) platform. @@ -19,8 +21,8 @@ For example, in the following query `logins` is the aggregate field and will b ```sql _sourceCategory=service "message=User logged in" remote_ip -| parse "[remote_ip=*]" as remote_ip -| lookup latitude, longitude from geo://location on ip = remote_ip +| parse "[remote_ip=*]" as remote_ip +| lookup latitude, longitude from geo://location on ip = remote_ip | count as logins by latitude, longitude ``` diff --git a/docs/dashboards-new/panels/single-value-charts.md b/docs/dashboards-new/panels/single-value-charts.md index ee9823f3b9..5d554b449f 100644 --- a/docs/dashboards-new/panels/single-value-charts.md +++ b/docs/dashboards-new/panels/single-value-charts.md @@ -1,9 +1,9 @@ --- id: single-value-charts +title: Single Value Charts +description: Displays the first record of your search results. --- -# Single Value Charts - You can use single value charts to display results for a search or metric query as a single value, for at-a-glance analysis. This page shows you how to create and tailor single value charts for searches. For information on single value charts for metrics, see [Create and Tailor Single Value Metrics Charts](/docs/metrics/metric-charts). A single value chart displays a single record from a search, in order to make that value stand out at a glance. If the query returns more than one value in the **Aggregates** tab, only the first value is displayed in the single value chart. @@ -34,12 +34,12 @@ To add a panel with a single value chart: ![Metrics selection for query builder.png](/img/dashboards-new/create-dashboard-new/Add-log-query.png) To create a metrics query utilize the [Metrics Query Builder](../../metrics/metric-queries-alerts/metrics-explorer.md).  - + ![new single value chart metrics.png](/img/dashboards-new/panels/single-value-charts/new-single-value-chart-metrics.png) 1. [Modify the chart](./modify-chart.md) as desired. -1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. +1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. ![Add to Dashboard button.png](/img/dashboards-new/create-dashboard-new/Add-to-Dashboard-button.png) diff --git a/docs/dashboards-new/panels/table-charts.md b/docs/dashboards-new/panels/table-charts.md index 43e1c19e53..946abf7fd2 100644 --- a/docs/dashboards-new/panels/table-charts.md +++ b/docs/dashboards-new/panels/table-charts.md @@ -1,8 +1,9 @@ --- id: table-charts +title: Table Charts +description: Table charts are the default chart type in the Aggregates tab. --- -# Table Charts Table charts are the default chart type in the **Aggregates** tab. They are useful for listing the type and number of events that have occurred, such as the type of error that occurs the most in your system. To create a table chart, use a search query that provides at least a few data points in the **Aggregates** tab. @@ -58,9 +59,9 @@ If your query looks for URLs, when you create a table chart panel, the URLs disp For example, if you used this query to search for hits to the Sumo Logic Help system: ```sql -_sourceCategory=aws/cloudtrail  -| keyvalue "LoginTo"  -| count loginto +_sourceCategory=aws/cloudtrail  +| keyvalue "LoginTo"  +| count loginto | sort - _count ``` diff --git a/docs/dashboards-new/set-custom-time-ranges.md b/docs/dashboards-new/set-custom-time-ranges.md index 3146ff2a69..4042b648f3 100644 --- a/docs/dashboards-new/set-custom-time-ranges.md +++ b/docs/dashboards-new/set-custom-time-ranges.md @@ -1,6 +1,7 @@ --- id: set-custom-time-ranges title: Set Customized Time Ranges +description: Learn how to set custom time ranges for individual panels and the dashboard as a whole. --- A new dashboard has a preset default time range for its panels and the dashboard as a whole. You can choose to customize the time range for individual panels, as well as setting a new time range for the dashboard. It's important that you review the time range override guidelines to ensure you achieve your expected results. diff --git a/docs/dashboards-new/share-dashboard-new.md b/docs/dashboards-new/share-dashboard-new.md index d3eb4c348c..dd71afdbfa 100644 --- a/docs/dashboards-new/share-dashboard-new.md +++ b/docs/dashboards-new/share-dashboard-new.md @@ -1,6 +1,7 @@ --- id: share-a-dashboard-new title: Share a Dashboard (New) +description: Learn how to save a custom dashboard and then share it with others. --- After you have created a custom Dashboard (New) you may also want to share it with coworkers within your organization. This page walks you through these tasks.