Skip to content

Commit 8341589

Browse files
authored
Merge pull request #224845 from oshezaf/asim/update-http-status-code-to-recommended
Renamed web-schema and updated status code to recommended
2 parents 26db3f4 + 5a961f2 commit 8341589

File tree

6 files changed

+11
-6
lines changed

6 files changed

+11
-6
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18384,6 +18384,11 @@
1838418384
"redirect_url": "/azure/sentinel/enable-monitoring",
1838518385
"redirect_document_id": false
1838618386
},
18387+
{
18388+
"source_path_from_root": "/articles/sentinel/web-normalization-schema.md",
18389+
"redirect_url": "/azure/sentinel/normalization-schema-web",
18390+
"redirect_document_id": true
18391+
},
1838718392
{
1838818393
"source_path_from_root": "/articles/sentinel/dns-normalization-schema.md",
1838918394
"redirect_url": "/azure/sentinel/normalization-schema-dns",

articles/sentinel/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@
576576
- name: ASIM user management schema
577577
href: user-management-normalization-schema.md
578578
- name: ASIM web session schema
579-
href: web-normalization-schema.md
579+
href: normalization-schema-web.md
580580
- name: Legacy network normalization schema
581581
href: normalization-schema-v1.md
582582
- name: Data collection references

articles/sentinel/normalization-about-parsers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Each schema has a standard set of filtering parameters documented in the relevan
6565
- [Authentication](authentication-normalization-schema.md)
6666
- [DNS](normalization-schema-dns.md#filtering-parser-parameters)
6767
- [Network Session](network-normalization-schema.md#filtering-parser-parameters)
68-
- [Web Session](web-normalization-schema.md#filtering-parser-parameters)
68+
- [Web Session](normalization-schema-web.md#filtering-parser-parameters)
6969

7070
Every schema that supports filtering parameters supports at least the `starttime` and `endtime` parameters and using them is often critical for optimizing performance.
7171

articles/sentinel/normalization-about-schemas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Schema references outline the fields that comprise each schema. ASIM currently d
2626
| [Process Event](process-events-normalization-schema.md) | 0.1.4 | Preview |
2727
| [Registry Event](registry-event-normalization-schema.md) | 0.1.2 | Preview |
2828
| [User Management](user-management-normalization-schema.md) | 0.1 | Preview |
29-
| [Web Session](web-normalization-schema.md) | 0.2.5 | Preview |
29+
| [Web Session](normalization-schema-web.md) | 0.2.5 | Preview |
3030

3131

3232
> [!IMPORTANT]

articles/sentinel/web-normalization-schema.md renamed to articles/sentinel/normalization-schema-web.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The most important fields in a Web Session schema are:
4141

4242
- [Url](#url), which reports the url that the client requested from the server.
4343
- The [SrcIpAddr](network-normalization-schema.md#srcipaddr) (aliased to [IpAddr](network-normalization-schema.md#ipaddr)), which represents the IP address from which the request was generated.
44-
- [EventResultDetails](#eventresultdetails) field, which reports the HTTP Status Code.
44+
- [EventResultDetails](#eventresultdetails) field, which typically reports the HTTP Status Code.
4545

4646
Web Session events may also include [User](network-normalization-schema.md#user) and [Process](process-events-normalization-schema.md) information for the user and process initiating the request.
4747

@@ -119,7 +119,7 @@ The following list mentions fields that have specific guidelines for Web Session
119119
|---------------------|-------------|------------|--------------------|
120120
| <a name='eventtype'></a>**EventType** | Mandatory | Enumerated | Describes the operation reported by the record. Allowed values are:<br> - `HTTPsession`: Denotes a network session used for HTTP or HTTPS, typically reported by an intermediary device, such as a proxy or a Web security gateway.<br> - `WebServerSession`: Denotes an HTTP request reported by a web server. Such an event typically has less network related information. The URL reported should not include a schema and a server name, but only the path and parameters part of the URL. <br> - `Api`: Denotes an HTTP request reported associated with an API call, typically reported by an application server. Such an event typically has less network related information. When reported by the application server, the URL reported should not include a schema and a server name, but only the path and parameters part of the URL. |
121121
| **EventResult** | Mandatory | Enumerated | Describes the event result, normalized to one of the following values: <br> - `Success` <br> - `Partial` <br> - `Failure` <br> - `NA` (not applicable) <br><br>For an HTTP session, `Success` is defined as a status code lower than `400`, and `Failure` is defined as a status code higher than `400`. For a list of HTTP status codes, refer to [W3 Org](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).<br><br>The source may provide only a value for the [EventResultDetails](#eventresultdetails) field, which must be analyzed to get the **EventResult** value. |
122-
| <a name="eventresultdetails"></a>**EventResultDetails** | Mandatory | String | For HTTP sessions, the value should be the HTTP status code. <br><br>**Note**: The value may be provided in the source record using different terms, which should be normalized to these values. The original value should be stored in the **EventOriginalResultDetails** field.|
122+
| <a name="eventresultdetails"></a>**EventResultDetails** | Recommended | String | The HTTP status code.<br><br>**Note**: The value may be provided in the source record using different terms, which should be normalized to these values. The original value should be stored in the **EventOriginalResultDetails** field.|
123123
| **EventSchema** | Mandatory | String | The name of the schema documented here is `WebSession`. |
124124
| **EventSchemaVersion** | Mandatory | String | The version of the schema. The version of the schema documented here is `0.2.6` |
125125
| **Dvc** fields| | | For Web Session events, device fields refer to the system reporting the Web Session event. This is typically an intermediary device for `HTTPSession` events, and the destination web or application server for `WebServerSession` and `ApiRequest` events. |

articles/sentinel/normalization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ ASIM currently defines the following schemas:
7070
- [Process Event](process-events-normalization-schema.md)
7171
- [Registry Event](registry-event-normalization-schema.md)
7272
- [User Management](user-management-normalization-schema.md)
73-
- [Web Session](web-normalization-schema.md)
73+
- [Web Session](normalization-schema-web.md)
7474

7575
For more information, see [ASIM schemas](normalization-about-schemas.md).
7676

0 commit comments

Comments
 (0)