Skip to content

Commit 2b2885d

Browse files
authored
Revert "Docusaurus Faster installation" (#4936)
* Revert "Docusaurus Faster (take 2) (#4928)" This reverts commit c8ad20e. * convert html tables to md where possible * aws fix * md fix
1 parent 302294e commit 2b2885d

File tree

22 files changed

+574
-1904
lines changed

22 files changed

+574
-1904
lines changed

LICENSE

Lines changed: 1 addition & 407 deletions
Large diffs are not rendered by default.

docs/api/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Sumo Logic has several deployments that are assigned depending on the geographic
8888

8989
Sumo Logic redirects your browser to the correct login URL and also redirects Collectors to the correct endpoint. However, if you're using an API you'll need to manually direct your API client to the correct Sumo Logic API URL.
9090

91-
<table>
91+
<table><small>
9292
<tr>
9393
<td>Deployment</td>
9494
<td>Service Endpoint (login URL)</td>
@@ -192,7 +192,7 @@ https://endpoint9.collection.us2.sumologic.com/</td>
192192
<td>syslog.collection.us2.sumologic.com</td>
193193
<td>https://open-collectors.us2.sumologic.com</td>
194194
</tr>
195-
195+
</small>
196196
</table>
197197

198198
### Which endpoint should I should use?

docs/api/organizations-management.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ With the Organizations Management API, you can get the credits usage details of
2828
| JP | https://api.jp.sumologic.com/docs/#tag/orgsManagement |
2929
| KR | https://api.kr.sumologic.com/docs/#tag/orgsManagement |
3030
| US1 | https://api.sumologic.com/docs/#tag/orgsManagement |
31-
| US2 | https://api.us2.sumologic.com/docs/#tag/orgsManagement<br/>https://organizations.sumologic.com/docs/#tag/organizationsManagement* <br/> *This assembly is exclusive to the US2 deployment and is designed to manage APIs for Sumo Logic orgs that are not tied to a specific deployment. For example, a parent organization might have child organizations across different deployments. As a result, the [List Organizations API](https://organizations.sumologic.com/docs/#operation/listOrganizations), which lists child organizations, is included in this assembly to accommodate child organizations spread across multiple deployments. |
31+
| US2 | https://api.us2.sumologic.com/docs/#tag/orgsManagement<br/>https://organizations.sumologic.com/docs/#tag/organizationsManagement <sup>`*`</sup> |
32+
33+
<sup>`*`</sup> This assembly is exclusive to the US2 deployment and manages APIs for Sumo Logic orgs not tied to a specific deployment, such as parent orgs with child orgs across multiple deployments. It includes the [List Organizations API](https://organizations.sumologic.com/docs/#operation/listOrganizations) to support this setup.
3234

3335
<!-- ## Required role capabilities
3436

docs/integrations/amazon-aws/aws-privatelink.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1313

1414
<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>
1515

16-
Sumo Logic provides the ability to configure private connectivity between your AWS Infrastructure and Sumologic via [AWS PrivateLink](https://aws.amazon.com/privatelink). This prevents any traffic from being accessible to the public internet.
16+
Sumo Logic provides the ability to configure private connectivity between your AWS Infrastructure and Sumologic via [AWS PrivateLink](https://aws.amazon.com/privatelink). This prevents any traffic from being accessible to the public internet.
1717

18-
Following sources are supported for AWS PrivateLink:
18+
Following sources are supported for AWS PrivateLink:
1919

2020
- **Installed Collector sources**. Data collected on Installed collectors deployed on customer VPC and sent to Sumo Logic.
2121
- **Sumo Logic OpenTelemetry Distro Collector sources**. Data collected on OpenTelemetry Distro collectors deployed on customer VPC and sent to Sumo Logic.
2222
- **HTTPs sources**. Data sent by the applications hosted in customers VPC and sent over to Sumologic using [HTTP Logs and Metrics Source](/docs/send-data/hosted-collectors/http-source/logs-metrics/) and Kinesis Firehose Source for Logs and Metrics.
23-
- **OTLP Source**. An [OTLP/HTTP Source](/docs/send-data/hosted-collectors/http-source/otlp/) is an endpoint for receiving OTLP-formatted Logs and Metrics from OpenTelemetry collectors using [OTLP exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.99.0/exporter/otlphttpexporter#otlphttp-exporter).
23+
- **OTLP Source**. An [OTLP/HTTP Source](/docs/send-data/hosted-collectors/http-source/otlp/) is an endpoint for receiving OTLP-formatted Logs and Metrics from OpenTelemetry collectors using [OTLP exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.99.0/exporter/otlphttpexporter#otlphttp-exporter).
2424

25-
The following sources are not supported for AWS PrivateLink:
25+
The following sources are not supported for AWS PrivateLink:
2626

27-
- Cloud Syslog
27+
- Cloud Syslog
2828
- AWS S3
2929
- AWS Cloudwatch source
3030
- RUM sources
@@ -37,7 +37,7 @@ With the NLB-created and ALB-registered as a target, requests over AWS PrivateL
3737

3838
Sumo Logic exposes AWS PrivateLink endpoints to different [regions that depend on your Sumo Logic deployment](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security). If you're using the VPC in a different region where the Sumo Logic PrivateLink endpoint service is set up, you need to set up VPC peering. Either way, you need to create an endpoint.
3939

40-
<table>
40+
<table><small>
4141
<tr>
4242
<td><strong>Deployment</strong></td>
4343
<td><strong>Collection Endpoint</strong></td>
@@ -119,7 +119,8 @@ https://endpoint9.collection.us2.sumologic.com</td>
119119
<td>https://open-collectors.us2.sumologic.com</td>
120120
<td>us-west-2</td>
121121
</tr>
122-
</table>
122+
</small></table>
123+
123124

124125
### Create an endpoint to connect with the Sumo Logic endpoint service
125126

docs/integrations/amazon-aws/global-intelligence-cloudtrail-secops.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This application relies on 45 Scheduled Searches that Save to two different Inde
5151
<details>
5252
<summary>View the list of Scheduled Searches (<strong>click to expand</strong>)</summary>
5353

54-
<table>
54+
<table><small>
5555
<tr>
5656
<td><strong>Folder</strong></td>
5757
<td><strong>Scheduled Search Name (prefixed with gis_benchmarks)</strong></td>
@@ -282,7 +282,7 @@ This application relies on 45 Scheduled Searches that Save to two different Inde
282282
<td>S3_ListBuckets</td>
283283
<td>Counts S3 events related to listing buckets.</td>
284284
</tr>
285-
</table>
285+
</small></table>
286286

287287
* To reduce false positives, the benchmarks and application filter out AWS CloudTrail events from legitimate cloud services including AWS itself and CloudHealth by VMware.
288288
* Security posture requirements may vary between AWS accounts for a given customer. For example, development accounts might have less strict controls than production accounts. The app supports filtering findings by AWS account ID to facilitate AWS account level posture assessment.

docs/integrations/amazon-aws/lambda.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -200,38 +200,21 @@ To collect the metrics in Sumo Logic, follow the steps below:
200200

201201
Once Provisioned Concurrency is enabled and you start collecting CloudWatch metrics, the following new metrics will be available:
202202

203-
<table>
204-
<tr>
205-
<td>Metric </td>
206-
<td>Description </td>
207-
</tr>
208-
<tr>
209-
<td><strong>ProvisionedConcurrentExecutions</strong> </td>
210-
<td>Concurrent Executions using Provisioned Concurrency </td>
211-
</tr>
212-
<tr>
213-
<td><strong>ProvisionedConcurrencyUtilization</strong> </td>
214-
<td>Fraction of Provisioned Concurrency in use </td>
215-
</tr>
216-
<tr>
217-
<td><strong>ProvisionedConcurrencyInvocations</strong> </td>
218-
<td>Number of Invocations using Provisioned Concurrency </td>
219-
</tr>
220-
<tr>
221-
<td><strong>ProvisionedConcurrencySpilloverInvocations</strong> </td>
222-
<td>Number of Invocations that are above Provisioned Concurrency </td>
223-
</tr>
224-
</table>
225-
203+
| Metric | Description |
204+
|:-----------|:-------------------------|
205+
| **ProvisionedConcurrentExecutions** | Concurrent Executions using Provisioned Concurrency |
206+
| **ProvisionedConcurrencyUtilization** | Fraction of Provisioned Concurrency in use |
207+
| **ProvisionedConcurrencyInvocations** | Number of Invocations using Provisioned Concurrency |
208+
| **ProvisionedConcurrencySpilloverInvocations** | Number of Invocations that are above Provisioned Concurrency |
226209

227210
These metrics can then be queried using Sumo Logic [Metrics queries](/docs/metrics/metrics-queries), as shown in the following example:
228211

229212
<img src={useBaseUrl('img/integrations/amazon-aws/AWS-Lambda-Search-Provisioned-Concurrency-Metrics.png')} alt="Search Provisioned Concurrency Metrics" />
230213

231214
### Field in Field Schema
232215

233-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
234-
1. Search for the “**functionname**” field.
216+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
217+
1. Search for the “**functionname**” field.
235218
1. If not present, create it. Learn how to create and manage fields [here](/docs/manage/fields.md#manage-fields).
236219

237220

docs/integrations/app-development/jfrog-artifactory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ In this step, you configure four local file sources, one for each log source lis
114114
115115
The following suffixes are required. For example, you could use `_sourceCategory=<Foo>/artifactory/console`, but the suffix **artifactory/console** must be used.
116116
117-
<table>
117+
<table><small>
118118
<tr>
119119
<td><strong>Log source</strong></td>
120120
<td><strong>File Path</strong></td>
@@ -139,7 +139,7 @@ The following suffixes are required. For example, you could use `_sourceCategory
139139
<td>Traffic</td>
140140
<td>$JFROG_HOME/&#60;product&#62;/var/log/artifactory-traffic.*.log</td>
141141
<td>artifactory/traffic</td>
142-
</tr>
142+
</tr></small>
143143
</table>
144144
145145
:::note

docs/integrations/app-development/jfrog-xray.md

Lines changed: 13 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -228,52 +228,19 @@ Advanced configuration can be used with all JFrog Xray script-based collection c
228228

229229
This section provides a list of variables for Jfrog Xray that you can define in the configuration file.
230230

231-
<table>
232-
<tr>
233-
<td>Variable </td>
234-
<td>Usage </td>
235-
</tr>
236-
<tr>
237-
<td>BACKFILL_DAYS in Collection Section </td>
238-
<td>Number of days before the event collection will start. If the value is 1, then events are fetched from yesterday to today. </td>
239-
</tr>
240-
<tr>
241-
<td>LOG_FORMAT in Logging Section </td>
242-
<td>Log format used by the python logging module to write logs in a file. </td>
243-
</tr>
244-
<tr>
245-
<td>ENABLE_LOGFILE in Logging Section </td>
246-
<td>Set to TRUE to write all logs and errors to a log file. </td>
247-
</tr>
248-
<tr>
249-
<td>ENABLE_CONSOLE_LOG in Logging Section </td>
250-
<td>Enables printing logs in a console. </td>
251-
</tr>
252-
<tr>
253-
<td>LOG_FILEPATH in Logging Section </td>
254-
<td>Path of the log file used when ENABLE_LOGFILE is set to TRUE. </td>
255-
</tr>
256-
<tr>
257-
<td>NUM_WORKERS in Collection Section </td>
258-
<td>Number of threads to spawn for API calls. </td>
259-
</tr>
260-
<tr>
261-
<td>MAX_RETRY in Collection Section </td>
262-
<td>Number of retries to attempt in case of request failure. </td>
263-
</tr>
264-
<tr>
265-
<td>BACKOFF_FACTOR in Collection Section </td>
266-
<td>A backoff factor to apply between attempts after the second try. If the backoff_factor is 0.1, then sleep() will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. </td>
267-
</tr>
268-
<tr>
269-
<td>TIMEOUT in Collection Section </td>
270-
<td>Request time out used by the requests library. </td>
271-
</tr>
272-
<tr>
273-
<td>HTTP_LOGS_ENDPOINT in SumoLogic sectio </td>
274-
<td>HTTP source endpoint url created in Sumo Logic for ingesting Logs. </td>
275-
</tr>
276-
</table>
231+
| Variable | Usage |
232+
|:----|:-----------------------|
233+
| BACKFILL_DAYS in Collection Section | Number of days before the event collection will start. If the value is 1, then events are fetched from yesterday to today. |
234+
| LOG_FORMAT in Logging Section | Log format used by the Python logging module to write logs in a file. |
235+
| ENABLE_LOGFILE in Logging Section | Set to TRUE to write all logs and errors to a log file. |
236+
| ENABLE_CONSOLE_LOG in Logging Section | Enables printing logs in a console. |
237+
| LOG_FILEPATH in Logging Section | Path of the log file used when ENABLE_LOGFILE is set to TRUE. |
238+
| NUM_WORKERS in Collection Section | Number of threads to spawn for API calls. |
239+
| MAX_RETRY in Collection Section | Number of retries to attempt in case of request failure. |
240+
| BACKOFF_FACTOR in Collection Section | A backoff factor to apply between attempts after the second try. If the backoff_factor is 0.1, then sleep() will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. |
241+
| TIMEOUT in Collection Section | Request timeout used by the requests library. |
242+
| HTTP_LOGS_ENDPOINT in Sumo Logic Section | HTTP source endpoint URL created in Sumo Logic for ingesting logs. |
243+
277244

278245
</details>
279246

docs/integrations/containers-orchestration/docker-ulm.md

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ There are alternative methods for collecting Docker logs and metrics. See [Docke
5050

5151
### Add a Docker logs source
5252

53-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
53+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
5454
2. Navigate to the collector you installed on the Docker host, and select **Add > Add Source**.
5555
3. Select **Docker Logs**. The Docker Logs page appears.
5656
4. Configure the source fields:
@@ -91,7 +91,7 @@ There are alternative methods for collecting Docker logs and metrics. See [Docke
9191
9292
### Add a Docker Stats Source
9393
94-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
94+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
9595
2. Navigate to the collector you installed on the Docker host, and select **Add > Add Source**.
9696
3. Select **Docker Stats.** The following Docker Stats page appears. There are two possible content types available, select **Metrics** to collect data as metrics, or select **Logs** (JSON) to collect data as JSON logs. To collect metrics for the Docker ULM app, select **Metrics** as the Content Type.
9797
4. Configure the source fields:
@@ -491,38 +491,11 @@ The table below defines the types of variables you can use.
491491

492492
Docker engine event log data doesn't support the tagging with metadata.
493493
494-
<table>
495-
<tr>
496-
<td><strong>Namespace/VAR_TYPE</strong> </td>
497-
<td><strong>Description</strong> </td>
498-
<td><strong>VAR_NAME</strong> </td>
499-
</tr>
500-
<tr>
501-
<td><code>container</code> </td>
502-
<td>Container metadata fields provided by Docker for use in the <code>--log-opt</code> tag option.
503-
<br/>These are automatically added to data points.
504-
<br/>For more information, see <a href="https://docs.docker.com/engine/admin/logging/log_tags/">Log tags for logging driver</a> in Docker help.</td>
505-
<td><code>ID</code> The first 12 characters of the container ID.
506-
<br/><code>FullID</code> The full container ID.
507-
<br/><code>Name</code> The container name.
508-
<br/><code>ImageID</code> The first 12 characters of the container’s image ID.
509-
<br/><code>ImageFullID</code> The container’s full image ID.
510-
<br/><code>ImageName</code> The name of the image used by the container. </td>
511-
</tr>
512-
<tr>
513-
<td><code>label</code> </td>
514-
<td>User-defined labels, supplied with the <code>--label flag</code> when starting a Docker container.
515-
<br/>This is automatically added to data points. </td>
516-
<td>The name of the variable.
517-
<br/>Dot characters (<code>.</code>) are not supported. </td>
518-
</tr>
519-
<tr>
520-
<td><code>env</code> </td>
521-
<td>User-defined container environment variables that are set with <code>--env|-e</code> flags when starting a container. </td>
522-
<td>The name of the variable.
523-
<br/>Dot characters (<code>.</code>) are not supported. </td>
524-
</tr>
525-
</table>
494+
| Namespace/VAR_TYPE | Description | VAR_NAME |
495+
|:--------------------|:------------------------------|:------------|
496+
| `container` | Container metadata fields provided by Docker for use in the `--log-opt` tag option.<br/>These are automatically added to data points.<br/>For more information, see [Log tags for logging driver](https://docs.docker.com/engine/admin/logging/log_tags/) in Docker help. | `ID`: The first 12 characters of the container ID.<br/>`FullID`: The full container ID.<br/>`Name`: The container name.<br/>`ImageID`: The first 12 characters of the container’s image ID.<br/>`ImageFullID`: The container’s full image ID.<br/>`ImageName`: The name of the image used by the container. |
497+
| `label` | User-defined labels, supplied with the `--label` flag when starting a Docker container.<br/>This is automatically added to data points. | The name of the variable.<br/>Dot characters (`.`) are not supported. |
498+
| `env` | User-defined container environment variables that are set with `--env\|-e` flags when starting a container. | The name of the variable.<br/>Dot characters (`.`) are not supported. |
526499
527500
528501
For example:

0 commit comments

Comments
 (0)