[DOCS-14286] Investigate changes in SERVER-54209: Audit index build lifecycle events Created: 11/Mar/21  Updated: 13/Nov/23  Resolved: 24/Mar/21

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.9.0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Naomi Pentrel (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-54209 Audit index build lifecycle events Closed
Participants:
Days since reply: 2 years, 46 weeks ago
Epic Link: DOCSP-9747
Story Points: 1

 Description   

Description

Downstream Change Summary

The System Event Audit Messages page needs to be updated for the `createIndex` audit event atype. The param field now appears as follows:

Unknown macro: { ns}

The possible values for `indexBuildState` are `IndexBuildStarted`, `IndexBuildSucceeded`, and `IndexBuildAborted`.

In addition, the result code should be updated to include the following:
0 - Success
276 - IndexBuildAborted

The `IndexBuildAborted` result code will be provided for `createIndex` audit events with param `IndexBuildState` set to `IndexBulidAborted`, while the `Success` result code will be provided for audit events with param `IndexBuildState` set to either `IndexBuildStarted` or `IndexBuildSucceeded`.

Description of Linked Ticket

We should indicate when index builds are started, complete, or are aborted. Currently, we only report when index builds are completed.

We should ensure that aborted index builds produce a createIndex event, with theĀ IndexBuildAborted (276) result code.

We should ensure that started index builds produce a createIndex event, with a distinct but identifying result code. We will create a new error code to accommodate this, to be named IndexBuildStarted.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 24/Mar/21 ]

Author:

{'name': 'Naomi Pentrel', 'email': '5212232+npentrel@users.noreply.github.com', 'username': 'npentrel'}

Message: DOCS-14286 update audit message for createIndex
Branch: v5.0
https://github.com/mongodb/docs/commit/34cba67827ca904082e5c048f6ba1a71892a5763

Generated at Thu Feb 08 08:10:00 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.