Skip to content

Commit b0e4f14

Browse files
authored
Merge branch 'main' into release-notes-collector
2 parents 2871e3a + 29f079c commit b0e4f14

File tree

6 files changed

+98
-214
lines changed

6 files changed

+98
-214
lines changed

docs/api/getting-started.md

Lines changed: 15 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -87,103 +87,21 @@ Sumo Logic has several deployments that are assigned depending on the geographic
8787

8888
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.
8989

90-
<table>
91-
<tr>
92-
<td>Deployment</td>
93-
<td>Service Endpoint (login URL)</td>
94-
<td>API Endpoint</td>
95-
<td>Collection Endpoint</td>
96-
<td>Cloud Syslog Endpoint</td>
97-
<td>OpenTelemetry Collector Endpoint</td>
98-
</tr>
99-
<tr>
100-
<td>AU</td>
101-
<td>https://service.au.sumologic.com</td>
102-
<td>https://api.au.sumologic.com/api/</td>
103-
<td>https://collectors.au.sumologic.com</td>
104-
<td>syslog.collection.au.sumologic.com</td>
105-
<td>https://open-collectors.au.sumologic.com</td>
106-
</tr>
107-
<tr>
108-
<td>CA</td>
109-
<td>https://service.ca.sumologic.com</td>
110-
<td>https://api.ca.sumologic.com/api/</td>
111-
<td>https://collectors.ca.sumologic.com</td>
112-
<td>syslog.collection.ca.sumologic.com</td>
113-
<td>https://open-collectors.ca.sumologic.com</td>
114-
</tr>
115-
<tr>
116-
<td>DE</td>
117-
<td>https://service.de.sumologic.com</td>
118-
<td>https://api.de.sumologic.com/api/</td>
119-
<td>https://collectors.de.sumologic.com</td>
120-
<td>syslog.collection.de.sumologic.com</td>
121-
<td>https://open-collectors.de.sumologic.com</td>
122-
</tr>
123-
<tr>
124-
<td>EU</td>
125-
<td>https://service.eu.sumologic.com</td>
126-
<td>https://api.eu.sumologic.com/api/</td>
127-
<td>https://collectors.eu.sumologic.com<br/>
128-
https://endpoint1.collection.eu.sumologic.com</td>
129-
<td>syslog.collection.eu.sumologic.com</td>
130-
<td>https://open-collectors.eu.sumologic.com</td>
131-
</tr>
132-
<tr>
133-
<td>FED</td>
134-
<td>https://service.fed.sumologic.com</td>
135-
<td>https://api.fed.sumologic.com/api/</td>
136-
<td>https://collectors.fed.sumologic.com</td>
137-
<td>syslog.collection.fed.sumologic.com</td>
138-
<td>https://open-collectors.fed.sumologic.com/</td>
139-
</tr>
140-
<tr>
141-
<td>JP</td>
142-
<td>https://service.jp.sumologic.com</td>
143-
<td>https://api.jp.sumologic.com/api/</td>
144-
<td>https://collectors.jp.sumologic.com</td>
145-
<td>syslog.collection.jp.sumologic.com</td>
146-
<td>https://open-collectors.jp.sumologic.com</td>
147-
</tr>
148-
<tr>
149-
<td>KR</td>
150-
<td>https://service.kr.sumologic.com</td>
151-
<td>https://api.kr.sumologic.com/api/</td>
152-
<td>https://collectors.kr.sumologic.com</td>
153-
<td>syslog.collection.kr.sumologic.com</td>
154-
<td>https://open-collectors.kr.sumologic.com</td>
155-
</tr>
156-
<tr>
157-
<td>US1</td>
158-
<td>https://service.sumologic.com/</td>
159-
<td>https://api.sumologic.com/api/</td>
160-
<td>https://collectors.sumologic.com<br/>
161-
https://endpoint1.collection.sumologic.com<br/>
162-
https://endpoint2.collection.sumologic.com<br/>
163-
https://endpoint3.collection.sumologic.com<br/>
164-
https://endpoint4.collection.sumologic.com<br/>
165-
https://endpoint5.collection.sumologic.com</td>
166-
<td>syslog.collection.us1.sumologic.com</td>
167-
<td>https://open-collectors.sumologic.com</td>
168-
</tr>
169-
<tr>
170-
<td>US2</td>
171-
<td>https://service.us2.sumologic.com</td>
172-
<td>https://api.us2.sumologic.com/api/</td>
173-
<td>https://collectors.us2.sumologic.com<br/>
174-
https://endpoint1.collection.us2.sumologic.com<br/>
175-
https://endpoint2.collection.us2.sumologic.com<br/>
176-
https://endpoint3.collection.us2.sumologic.com<br/>
177-
https://endpoint4.collection.us2.sumologic.com<br/>
178-
https://endpoint5.collection.us2.sumologic.com<br/>
179-
https://endpoint6.collection.us2.sumologic.com<br/>
180-
https://endpoint7.collection.us2.sumologic.com<br/>
181-
https://endpoint8.collection.us2.sumologic.com<br/>
182-
https://endpoint9.collection.us2.sumologic.com/</td>
183-
<td>syslog.collection.us2.sumologic.com</td>
184-
<td>https://open-collectors.us2.sumologic.com</td>
185-
</tr>
186-
</table>
90+
<div class="responsive-table">
91+
92+
| Region | Service<br/>(login URL) | API endpoint | Collection | Syslog | OTel |
93+
|:--|:--|:--|:--|:--|:--|
94+
| AU | [service.au.sumologic.com](https://service.au.sumologic.com) | `api.au.sumologic.com/api/` | `collectors.au.sumologic.com` | `syslog.collection.au.sumologic.com` | `open-collectors.au.sumologic.com` |
95+
| CA | [service.ca.sumologic.com](https://service.ca.sumologic.com) | `api.ca.sumologic.com/api/` | `collectors.ca.sumologic.com` | `syslog.collection.ca.sumologic.com` | `open-collectors.ca.sumologic.com` |
96+
| DE | [service.de.sumologic.com](https://service.de.sumologic.com) | `api.de.sumologic.com/api/` | `collectors.de.sumologic.com` | `syslog.collection.de.sumologic.com` | `open-collectors.de.sumologic.com` |
97+
| EU | [service.eu.sumologic.com](https://service.eu.sumologic.com) | `api.eu.sumologic.com/api/` | `collectors.eu.sumologic.com`<br/>`endpoint1.collection.eu.sumologic.com` | `syslog.collection.eu.sumologic.com` | `open-collectors.eu.sumologic.com` |
98+
| FED | [service.fed.sumologic.com](https://service.fed.sumologic.com) | `api.fed.sumologic.com/api/` | `collectors.fed.sumologic.com` | `syslog.collection.fed.sumologic.com` | `open-collectors.fed.sumologic.com` |
99+
| JP | [service.jp.sumologic.com](https://service.jp.sumologic.com) | `api.jp.sumologic.com/api/` | `collectors.jp.sumologic.com` | `syslog.collection.jp.sumologic.com` | `open-collectors.jp.sumologic.com` |
100+
| KR | [service.kr.sumologic.com](https://service.kr.sumologic.com) | `api.kr.sumologic.com/api/` | `collectors.kr.sumologic.com` | `syslog.collection.kr.sumologic.com` | `open-collectors.kr.sumologic.com` |
101+
| US1 | [service.sumologic.com](https://service.sumologic.com) | `api.sumologic.com/api/` | `collectors.sumologic.com`<br/>`endpoint1-5.collection.sumologic.com` | `syslog.collection.us1.sumologic.com` | `open-collectors.sumologic.com` |
102+
| US2 | [service.us2.sumologic.com](https://service.us2.sumologic.com) | `api.us2.sumologic.com/api/` | `collectors.us2.sumologic.com`<br/>`endpoint1-9.collection.us2.sumologic.com` | `syslog.collection.us2.sumologic.com` | `open-collectors.us2.sumologic.com` |
103+
104+
</div>
187105

188106
### Which endpoint should I should use?
189107

docs/contributing/style-guide.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -735,30 +735,42 @@ You can use a link to a file embedding the entire file, or embed a range of code
735735
</TabItem>
736736
</Tabs>
737737
738-
### Image sizes
738+
### Logos
739739
740-
When sizing images, use your discretion.
741-
742-
#### Logos
743-
744-
For square logos, set the width to about 45-55px.
740+
When sizing images, use your discretion. For square logos, set the width to about 45-55px.
745741
746742
| &#9989; **Do** | &#10060; **Don't** |
747743
|:---------------|:-------------------|
748744
| <img src={useBaseUrl('img/contributing/logo-yes.png')} alt="Screenshot showing correctly sized logo" width="400"/> | <img src={useBaseUrl('img/contributing/logo-no.png')} alt="Screenshot showing oversized logo" width="440"/> |
749745
750746
For wide logos (like [in this doc](/docs/integrations/microsoft-azure/iis-7/)), set the width to about 90-120px.
751747
752-
#### Screenshots
748+
### Screenshots
749+
750+
Use screenshots only when they clarify complex instructions. Our UI changes often, so minimizing screenshots reduces maintenance overhead.
751+
752+
* Prefer clear, concise text instructions over images when possible.
753+
* Only include screenshots if they significantly aid user understanding.
754+
* Avoid screenshots for simple UI interactions.
755+
* When updating docs, evaluate whether screenshots are outdated or redundant.
756+
* If you come across unnecessary screenshots, use your judgment to delete or replace them.
753757
754-
Ensure that screenshots are large enough so that the content is legible, but not comically oversized. Use your discretion.
758+
Make sure screenshots are large enough to be legible, but never wider than 800px. Avoid oversized images.
759+
760+
By default, images that you insert into a page are set to be responsive-resized for the type of device the reader is using.
761+
762+
Use the following syntax to add screenshots:
763+
764+
```md
765+
<img src={useBaseUrl('img/<your-image-file>.png')} alt="Descriptive alt text" style={{border: '1px solid gray'}} width="500" />
766+
```
767+
768+
Add appropriate `alt` text for accessibility. See [Add an image](#add-an-image) for more.
755769
756770
| &#9989; **Do** | &#10060; **Don't** |
757771
|:---------------|:-------------------|
758772
| <img src={useBaseUrl('img/contributing/screenshot-yes.png')} alt="alt-text" width="400"/> | <img src={useBaseUrl('img/contributing/screenshot-no.png')} alt="alt-text" width="400"/> |
759773
760-
Screenshots should never be wider than 600px.
761-
762774
### Images in lists
763775
764776
When adding an image to a bulleted or sequential list, include the image snippet in-line with the list item, with a `<br/>` element in between, like this:
@@ -785,13 +797,6 @@ When adding an image to a bulleted or sequential list, include the image snippet
785797
</TabItem>
786798
</Tabs>
787799
788-
### Screenshots
789-
790-
Capture screenshots using SnagIt in .png format. Use SnagIt's border effect to apply a gray (RGB 212, 212, 212) four-point border.
791-
792-
By default, images that you insert into a page are set to be responsive - resized for the type of device the reader is using.
793-
794-
795800
### Masking sensitive information
796801
797802
We mask sensitive information like usernames, email addresses, and IP addresses. In Snagit or a similar program, use the shape tool to mask the text using solid gray, (RGB 212, 212, 212).

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

Lines changed: 14 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -37,78 +37,20 @@ 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>
41-
<tr>
42-
<td><strong>Deployment</strong></td>
43-
<td><strong>Collection Endpoint</strong></td>
44-
<td><strong>OpenTelemetry Collector Endpoint</strong></td>
45-
<td><strong>AWS Region of Sumo PrivateLink Endpoint Service</strong></td>
46-
</tr>
47-
<tr>
48-
<td>AU</td>
49-
<td>https://collectors.au.sumologic.com</td>
50-
<td>https://open-collectors.au.sumologic.com</td>
51-
<td>ap-southeast-2</td>
52-
</tr>
53-
<tr>
54-
<td>CA</td>
55-
<td>https://collectors.ca.sumologic.com</td>
56-
<td>https://open-collectors.ca.sumologic.com</td>
57-
<td>ca-central-1</td>
58-
</tr>
59-
<tr>
60-
<td>DE</td>
61-
<td>https://collectors.de.sumologic.com</td>
62-
<td>https://open-collectors.de.sumologic.com</td>
63-
<td>eu-central-1</td>
64-
</tr>
65-
<tr>
66-
<td>EU</td>
67-
<td>https://collectors.eu.sumologic.com<br/>
68-
https://endpoint1.collection.eu.sumologic.com</td>
69-
<td>https://open-collectors.eu.sumologic.com</td>
70-
<td>eu-west-1</td>
71-
</tr>
72-
<tr>
73-
<td>JP</td>
74-
<td>https://collectors.jp.sumologic.com</td>
75-
<td>https://open-collectors.jp.sumologic.com</td>
76-
<td>ap-northeast-1</td>
77-
</tr>
78-
<tr>
79-
<td>KR</td>
80-
<td>https://collectors.kr.sumologic.com<br/></td>
81-
<td>https://open-collectors.kr.sumologic.com</td>
82-
<td>ap-northeast-2</td>
83-
</tr>
84-
<tr>
85-
<td>US1</td>
86-
<td>https://collectors.sumologic.com<br/>
87-
https://endpoint1.collection.sumologic.com<br/>
88-
https://endpoint2.collection.sumologic.com<br/>
89-
https://endpoint3.collection.sumologic.com<br/>
90-
https://endpoint4.collection.sumologic.com<br/>
91-
https://endpoint5.collection.sumologic.com</td>
92-
<td>https://open-collectors.sumologic.com</td>
93-
<td>us-east-1</td>
94-
</tr>
95-
<tr>
96-
<td>US2</td>
97-
<td>https://collectors.us2.sumologic.com<br/>
98-
https://endpoint1.collection.us2.sumologic.com<br/>
99-
https://endpoint2.collection.us2.sumologic.com<br/>
100-
https://endpoint3.collection.us2.sumologic.com<br/>
101-
https://endpoint4.collection.us2.sumologic.com<br/>
102-
https://endpoint5.collection.us2.sumologic.com<br/>
103-
https://endpoint6.collection.us2.sumologic.com<br/>
104-
https://endpoint7.collection.us2.sumologic.com<br/>
105-
https://endpoint8.collection.us2.sumologic.com<br/>
106-
https://endpoint9.collection.us2.sumologic.com</td>
107-
<td>https://open-collectors.us2.sumologic.com</td>
108-
<td>us-west-2</td>
109-
</tr>
110-
</table>
111-
40+
<div class="responsive-table">
41+
42+
| Deployment | Collection endpoint | OpenTelemetry collector endpoint | AWS Region of Sumo PrivateLink endpoint service |
43+
|:-----------|:---------------------|:----------------------------------|:------------------------------------------------|
44+
| AU | `collectors.au.sumologic.com` | `open-collectors.au.sumologic.com` | `ap-southeast-2` |
45+
| CA | `collectors.ca.sumologic.com` | `open-collectors.ca.sumologic.com` | `ca-central-1` |
46+
| DE | `collectors.de.sumologic.com` | `open-collectors.de.sumologic.com` | `eu-central-1` |
47+
| EU | `collectors.eu.sumologic.com`<br/>`endpoint1.collection.eu.sumologic.com` | `open-collectors.eu.sumologic.com` | `eu-west-1` |
48+
| JP | `collectors.jp.sumologic.com` | `open-collectors.jp.sumologic.com` | `ap-northeast-1` |
49+
| KR | `collectors.kr.sumologic.com` | `open-collectors.kr.sumologic.com` | `ap-northeast-2` |
50+
| US1 | `collectors.sumologic.com`<br/>`endpoint1.collection.sumologic.com`<br/>`endpoint2.collection.sumologic.com`<br/>`endpoint3.collection.sumologic.com`<br/>`endpoint4.collection.sumologic.com`<br/>`endpoint5.collection.sumologic.com` | `open-collectors.sumologic.com` | `us-east-1` |
51+
| US2 | `collectors.us2.sumologic.com`<br/>`endpoint1.collection.us2.sumologic.com`<br/>`endpoint2.collection.us2.sumologic.com`<br/>`endpoint3.collection.us2.sumologic.com`<br/>`endpoint4.collection.us2.sumologic.com`<br/>`endpoint5.collection.us2.sumologic.com`<br/>`endpoint6.collection.us2.sumologic.com`<br/>`endpoint7.collection.us2.sumologic.com`<br/>`endpoint8.collection.us2.sumologic.com`<br/>`endpoint9.collection.us2.sumologic.com` | `open-collectors.us2.sumologic.com` | `us-west-2` |
52+
53+
</div>
11254

11355
### Create an endpoint to connect with the Sumo Logic endpoint service
11456

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ 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+
<div class="responsive-table">
55+
5456
<table>
5557
<tr>
5658
<td><strong>Folder</strong></td>
@@ -284,6 +286,8 @@ This application relies on 45 Scheduled Searches that Save to two different Inde
284286
</tr>
285287
</table>
286288

289+
</div>
290+
287291
* To reduce false positives, the benchmarks and application filter out AWS CloudTrail events from legitimate cloud services including AWS itself and CloudHealth by VMware.
288292
* 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.
289293
* The benchmarking models use cohorts calculated from similar AWS accounts.

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

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -114,33 +114,16 @@ 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>
118-
<tr>
119-
<td><strong>Log source</strong></td>
120-
<td><strong>File Path</strong></td>
121-
<td><strong>Source Category</strong></td>
122-
</tr>
123-
<tr>
124-
<td>Artifactory Server and other microservices</td>
125-
<td>$JFROG_HOME/&#60;product&#62;/var/log/artifactory-service.log</td>
126-
<td>artifactory/console</td>
127-
</tr>
128-
<tr>
129-
<td>Access</td>
130-
<td>$JFROG_HOME/artifactory/var/artifactory/log/artifactory-access.log.</td>
131-
<td>artifactory/access</td>
132-
</tr>
133-
<tr>
134-
<td>Request</td>
135-
<td>$JFROG_HOME/&#60;product&#62;/var/log/artifactory-request.log</td>
136-
<td>artifactory/request</td>
137-
</tr>
138-
<tr>
139-
<td>Traffic</td>
140-
<td>$JFROG_HOME/&#60;product&#62;/var/log/artifactory-traffic.*.log</td>
141-
<td>artifactory/traffic</td>
142-
</tr>
143-
</table>
117+
<div class="responsive-table">
118+
119+
| Log source | File Path | Source Category |
120+
|:----------------------------------|:--------------------------------------------------------------------|:-----------------------|
121+
| Artifactory Server and other microservices | `$JFROG_HOME/<product>/var/log/artifactory-service.log` | `artifactory/console` |
122+
| Access | `$JFROG_HOME/artifactory/var/artifactory/log/artifactory-access.log.` | `artifactory/access` |
123+
| Request | `$JFROG_HOME/<product>/var/log/artifactory-request.log` | `artifactory/request` |
124+
| Traffic | `$JFROG_HOME/<product>/var/log/artifactory-traffic.*.log` | `artifactory/traffic` |
125+
126+
</div>
144127
145128
:::note
146129
Remember that `_sourceCategory` names are case sensitive. When you run a search using `_sourceCategory`, make sure you use the same case as you did when configuring the source.

src/css/sumo.scss

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -981,7 +981,33 @@ html[data-theme='dark'] .node polygon {
981981
stroke: #2196F3 !important;
982982
}
983983

984+
// reduce width of wide tables
985+
.responsive-table {
986+
overflow-x: auto;
987+
width: 100%;
988+
font-size: 0.8rem; /* Shrinks font for tighter layout */
989+
}
990+
991+
.responsive-table table {
992+
width: 100%;
993+
table-layout: fixed;
994+
border-collapse: collapse;
995+
}
984996

997+
.responsive-table code {
998+
font-size: 0.7rem;
999+
line-height: 1.3; /* slightly tighter if desired */
1000+
}
1001+
1002+
.responsive-table th,
1003+
.responsive-table td {
1004+
text-align: left;
1005+
word-break: break-word;
1006+
white-space: normal;
1007+
padding: 0.75rem 0.5rem; /* Adds vertical breathing room */
1008+
max-width: 220px; /* Can adjust based on layout needs */
1009+
min-width: 65px; /* Can adjust based on layout needs */
1010+
}
9851011

9861012
// Hub pages
9871013

@@ -1370,7 +1396,13 @@ html[data-theme='dark'] .featureImage {
13701396
padding: 0 !important;
13711397
}
13721398

1373-
.title_f1Hy {
1399+
/* Force smaller font size on blog post titles */
1400+
article header h1, article header h2 {
1401+
font-size: 1.5rem !important;
1402+
}
1403+
1404+
article header h1[class*='title_'],
1405+
article header h2[class*='title_'] {
13741406
font-size: 1.5rem !important;
13751407
}
13761408

0 commit comments

Comments
 (0)