Audit log proposal wip #4990

capaj · 2024-06-18T08:23:22Z

just for review purposes, don't merge

changeset-bot · 2024-06-18T08:23:26Z

⚠️ No Changeset found

Latest commit: 9fcbb60

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2024-06-18T08:26:37Z

🐋 This PR was built and pushed to the following Docker images (tag: 9fcbb6073d9a38a85b16ff92641ee31a823f1239):

Docker Bake metadata

{
"app": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/86jq51umh9qwcjbpph9w3ysbu",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:539c065dad908bd85b4666254d05772923aba7dd35bacc60ea2316b48b846fe5",
    "size": 685
  },
  "containerimage.digest": "sha256:539c065dad908bd85b4666254d05772923aba7dd35bacc60ea2316b48b846fe5",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/app:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/app:audit_log_wip"
},
"composition-federation-2": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/68nux27o9hzkuhly69glr429x",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:7fc7661783301a65775265be08d412b578f5bbaf1f228e02e81e629a874013be",
    "size": 685
  },
  "containerimage.digest": "sha256:7fc7661783301a65775265be08d412b578f5bbaf1f228e02e81e629a874013be",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/composition-federation-2:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/composition-federation-2:audit_log_wip"
},
"emails": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/5oa28gcjztxolrz46t2xcki7f",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:57e51764125489a5f2707789e59f935c0e0fb2f7da302dbd5357fa80453c4020",
    "size": 685
  },
  "containerimage.digest": "sha256:57e51764125489a5f2707789e59f935c0e0fb2f7da302dbd5357fa80453c4020",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/emails:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/emails:audit_log_wip"
},
"policy": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/f0xxlzpidslh6dkxars1vyeko",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:8c99e550237485fd7ba91756757de22b77c37594b45d96541360cede0bd772f6",
    "size": 685
  },
  "containerimage.digest": "sha256:8c99e550237485fd7ba91756757de22b77c37594b45d96541360cede0bd772f6",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/policy:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/policy:audit_log_wip"
},
"rate-limit": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/prvvlu9zcxod4hnbit2gybdqo",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:07344efa2254701a2646c494182ae24aa949092847cf1cc574d82b0335af98d0",
    "size": 685
  },
  "containerimage.digest": "sha256:07344efa2254701a2646c494182ae24aa949092847cf1cc574d82b0335af98d0",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/rate-limit:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/rate-limit:audit_log_wip"
},
"schema": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/uu8pgip2khqms2lodk20vwdr3",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:1dbf36028242c349bf3065018b3fa3fe76d8cf574e60e853e6f03b2450853f9c",
    "size": 685
  },
  "containerimage.digest": "sha256:1dbf36028242c349bf3065018b3fa3fe76d8cf574e60e853e6f03b2450853f9c",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/schema:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/schema:audit_log_wip"
},
"server": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/v1oxvqiifww1w2ecwpgrtiort",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:e8af9f1194403b483cde85f7c11dfb36bff103570c4050a68513b879849703be",
    "size": 685
  },
  "containerimage.digest": "sha256:e8af9f1194403b483cde85f7c11dfb36bff103570c4050a68513b879849703be",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/server:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/server:audit_log_wip"
},
"storage": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/rqqiqqzvizhwdwenn3vi7p2fd",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:1e0a19e7fcca5d4addf97a552c6d66feb2a0b06de13b8e30cc6b6836fa719125",
    "size": 685
  },
  "containerimage.digest": "sha256:1e0a19e7fcca5d4addf97a552c6d66feb2a0b06de13b8e30cc6b6836fa719125",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/storage:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/storage:audit_log_wip"
},
"stripe-billing": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/yx4umneupru26970r3ptybmy6",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:b40bef43cdb9bd55089f435dae88f690e81935ae1f395b6949704316fcde56ae",
    "size": 685
  },
  "containerimage.digest": "sha256:b40bef43cdb9bd55089f435dae88f690e81935ae1f395b6949704316fcde56ae",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/stripe-billing:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/stripe-billing:audit_log_wip"
},
"tokens": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/2t44x5dp1pvpxu6388mcgf1i6",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:09de7dc08a8d6eaa02bc137242c3a530f4423782cdb4c88743c4c8b7e58b9a00",
    "size": 685
  },
  "containerimage.digest": "sha256:09de7dc08a8d6eaa02bc137242c3a530f4423782cdb4c88743c4c8b7e58b9a00",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/tokens:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/tokens:audit_log_wip"
},
"usage": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/rf24lgkc3yl0m6hthxnfrnp00",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:35e55d1a7271444594f5406aadb4491ce9d3c9ae5acd6a968878c22e08f6c80b",
    "size": 685
  },
  "containerimage.digest": "sha256:35e55d1a7271444594f5406aadb4491ce9d3c9ae5acd6a968878c22e08f6c80b",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/usage:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/usage:audit_log_wip"
},
"usage-estimator": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/abovun7ysqwdbedp7pii959mt",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:0762c150e10420da5f6d8e43d5c033d7eaa0bbee0bedbbfe001c1f00b826fe68",
    "size": 685
  },
  "containerimage.digest": "sha256:0762c150e10420da5f6d8e43d5c033d7eaa0bbee0bedbbfe001c1f00b826fe68",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/usage-estimator:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/usage-estimator:audit_log_wip"
},
"usage-ingestor": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/uus3w247zpqrxdcujollhi5bz",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:c15708a565738b2f5a3f6b5a6924e719499dab9edf3aa9911a80effe073bb83f",
    "size": 685
  },
  "containerimage.digest": "sha256:c15708a565738b2f5a3f6b5a6924e719499dab9edf3aa9911a80effe073bb83f",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/usage-ingestor:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/usage-ingestor:audit_log_wip"
},
"webhooks": {
  "buildx.build.ref": "builder-040c5276-f5cf-4fbf-9d8f-5926d887da82/builder-040c5276-f5cf-4fbf-9d8f-5926d887da820/npwz1qdit3b00mfcp76yvu4wr",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.list.v2+json",
    "digest": "sha256:6674ab906d3da70377f08e4449b9c3f2991b0c776f61b3c8500d6c9817cc40f3",
    "size": 685
  },
  "containerimage.digest": "sha256:6674ab906d3da70377f08e4449b9c3f2991b0c776f61b3c8500d6c9817cc40f3",
  "image.name": "ghcr.io/kamilkisiela/graphql-hive/webhooks:9fcbb6073d9a38a85b16ff92641ee31a823f1239,ghcr.io/kamilkisiela/graphql-hive/webhooks:audit_log_wip"
}
}

docs/proposals/proposal-audit-log.md

n1ru4l · 2024-06-18T09:38:12Z

@capaj Compiling this list based on GraphQL mutation root fields might be more useful as they already describe the actions from a user point of view. Then from there, we can pick the classes/methods that have the business logic for these.

See the schema.graphql file.

type Mutation {
  activateAppDeployment(input: ActivateAppDeploymentInput!): ActivateAppDeploymentResult!
  addAlert(input: AddAlertInput!): AddAlertResult!
  addAlertChannel(input: AddAlertChannelInput!): AddAlertChannelResult!
  addDocumentsToAppDeployment(input: AddDocumentsToAppDeploymentInput!): AddDocumentsToAppDeploymentResult!
  addGitHubIntegration(input: AddGitHubIntegrationInput!): Boolean!
  addSlackIntegration(input: AddSlackIntegrationInput!): Boolean!
  answerOrganizationTransferRequest(input: AnswerOrganizationTransferRequestInput!): AnswerOrganizationTransferRequestResult!
  """Approve a failed schema check with breaking changes."""
  approveFailedSchemaCheck(input: ApproveFailedSchemaCheckInput!): ApproveFailedSchemaCheckResult!
  assignMemberRole(input: AssignMemberRoleInput!): AssignMemberRoleResult!
  createAppDeployment(input: CreateAppDeploymentInput!): CreateAppDeploymentResult!
  createCdnAccessToken(input: CreateCdnAccessTokenInput!): CdnAccessTokenCreateResult!
  """Create a contract for a given target."""
  createContract(input: CreateContractInput!): CreateContractResult!
  createDocumentCollection(input: CreateDocumentCollectionInput!, selector: TargetSelectorInput!): ModifyDocumentCollectionResult!
  createMemberRole(input: CreateMemberRoleInput!): CreateMemberRoleResult!
  createOIDCIntegration(input: CreateOIDCIntegrationInput!): CreateOIDCIntegrationResult!
  createOperationInDocumentCollection(input: CreateDocumentCollectionOperationInput!, selector: TargetSelectorInput!): ModifyDocumentCollectionOperationResult!
  createOrganization(input: CreateOrganizationInput!): CreateOrganizationResult!
  createProject(input: CreateProjectInput!): CreateProjectResult!
  createTarget(input: CreateTargetInput!): CreateTargetResult!
  createToken(input: CreateTokenInput!): CreateTokenResult!
  deleteAlertChannels(input: DeleteAlertChannelsInput!): DeleteAlertChannelsResult!
  deleteAlerts(input: DeleteAlertsInput!): DeleteAlertsResult!
  deleteCdnAccessToken(input: DeleteCdnAccessTokenInput!): DeleteCdnAccessTokenResult!
  deleteDocumentCollection(id: ID!, selector: TargetSelectorInput!): DeleteDocumentCollectionResult!
  deleteGitHubIntegration(input: OrganizationSelectorInput!): DeleteGitHubIntegrationResult!
  deleteMemberRole(input: DeleteMemberRoleInput!): DeleteMemberRoleResult!
  deleteOIDCIntegration(input: DeleteOIDCIntegrationInput!): DeleteOIDCIntegrationResult!
  deleteOperationInDocumentCollection(id: ID!, selector: TargetSelectorInput!): DeleteDocumentCollectionOperationResult!
  deleteOrganization(selector: OrganizationSelectorInput!): OrganizationPayload!
  deleteOrganizationInvitation(input: DeleteOrganizationInvitationInput!): DeleteOrganizationInvitationResult!
  deleteOrganizationMember(input: OrganizationMemberInput!): OrganizationPayload!
  deleteProject(selector: ProjectSelectorInput!): DeleteProjectPayload!
  deleteSlackIntegration(input: OrganizationSelectorInput!): DeleteSlackIntegrationResult!
  deleteTarget(selector: TargetSelectorInput!): DeleteTargetPayload!
  deleteTokens(input: DeleteTokensInput!): DeleteTokensPayload!
  """Disable a contract."""
  disableContract(input: DisableContractInput!): DisableContractResult!
  disableExternalSchemaComposition(input: DisableExternalSchemaCompositionInput!): DisableExternalSchemaCompositionResult!
  downgradeToHobby(input: DowngradeToHobbyInput!): ChangePlanResult!
  enableExternalSchemaComposition(input: EnableExternalSchemaCompositionInput!): EnableExternalSchemaCompositionResult!
  enableProjectNameInGithubCheck(input: ProjectSelectorInput!): Project!
  """
  Overwrites project's schema composition library.
  Works only for Federation projects with native composition enabled.
  This mutation is temporary and will be removed once no longer needed.
  It's part of a feature flag called "forceLegacyCompositionInTargets".
  """
  experimental__updateTargetSchemaComposition(input: Experimental__UpdateTargetSchemaCompositionInput!): Target!
  generateStripePortalLink(selector: OrganizationSelectorInput!): String!
  inviteToOrganizationByEmail(input: InviteToOrganizationByEmailInput!): InviteToOrganizationByEmailResult!
  joinOrganization(code: String!): JoinOrganizationPayload!
  leaveOrganization(input: OrganizationSelectorInput!): LeaveOrganizationResult!
  """Remove this mutation after migration is complete."""
  migrateUnassignedMembers(input: MigrateUnassignedMembersInput!): MigrateUnassignedMembersResult!
  noop(noop: String): Boolean
  requestOrganizationTransfer(input: RequestOrganizationTransferInput!): RequestOrganizationTransferResult!
  retireAppDeployment(input: RetireAppDeploymentInput!): RetireAppDeploymentResult!
  """Requires API Token"""
  schemaCheck(input: SchemaCheckInput!): SchemaCheckPayload!
  """Requires API Token"""
  schemaCompose(input: SchemaComposeInput!): SchemaComposePayload!
  """Requires API Token"""
  schemaDelete(input: SchemaDeleteInput!): SchemaDeleteResult!
  """Requires API Token"""
  schemaPublish(input: SchemaPublishInput!): SchemaPublishPayload!
  sendFeedback(feedback: String!): Boolean!
  setTargetValidation(input: SetTargetValidationInput!): Target!
  supportTicketCreate(input: SupportTicketCreateInput!): SupportTicketCreateResult!
  supportTicketReply(input: SupportTicketReplyInput!): SupportTicketReplyResult!
  updateBaseSchema(input: UpdateBaseSchemaInput!): UpdateBaseSchemaResult!
  updateDocumentCollection(input: UpdateDocumentCollectionInput!, selector: TargetSelectorInput!): ModifyDocumentCollectionResult!
  updateMe(input: UpdateMeInput!): UpdateMeResult!
  updateMemberRole(input: UpdateMemberRoleInput!): UpdateMemberRoleResult!
  updateNativeFederation(input: UpdateNativeFederationInput!): UpdateNativeFederationResult!
  updateOIDCIntegration(input: UpdateOIDCIntegrationInput!): UpdateOIDCIntegrationResult!
  updateOperationInDocumentCollection(input: UpdateDocumentCollectionOperationInput!, selector: TargetSelectorInput!): ModifyDocumentCollectionOperationResult!
  updateOrgRateLimit(monthlyLimits: RateLimitInput!, selector: OrganizationSelectorInput!): Organization!
  updateOrganizationMemberAccess(input: OrganizationMemberAccessInput!): OrganizationPayload!
  updateOrganizationName(input: UpdateOrganizationNameInput!): UpdateOrganizationNameResult!
  updateProjectName(input: UpdateProjectNameInput!): UpdateProjectNameResult!
  updateProjectRegistryModel(input: UpdateProjectRegistryModelInput!): UpdateProjectRegistryModelResult!
  updateSchemaPolicyForOrganization(allowOverrides: Boolean!, policy: SchemaPolicyInput!, selector: OrganizationSelectorInput!): UpdateSchemaPolicyResult!
  updateSchemaPolicyForProject(policy: SchemaPolicyInput!, selector: ProjectSelectorInput!): UpdateSchemaPolicyResult!
  updateSchemaVersionStatus(input: SchemaVersionUpdateInput!): SchemaVersion!
  """Updates the target's explorer endpoint url."""
  updateTargetGraphQLEndpointUrl(input: UpdateTargetGraphQLEndpointUrlInput!): UpdateTargetGraphQLEndpointUrlResult!
  updateTargetName(input: UpdateTargetNameInput!): UpdateTargetNameResult!
  updateTargetValidationSettings(input: UpdateTargetValidationSettingsInput!): UpdateTargetValidationSettingsResult!
  upgradeToPro(input: UpgradeToProInput!): ChangePlanResult!
}

capaj · 2024-06-18T13:26:24Z

@n1ru4l I did it based on the provider typescript classes as suggested here:

https://guild-oss.slack.com/archives/C01E8ATBQGN/p1718616626696269?thread_ts=1718613813.068609&cid=C01E8ATBQGN

Are there still too many events missing? I have added a lot of them from Storage interface now.

docs/proposals/proposal-audit-log.md

scripts/get-services-outline.ts

docs/proposals/proposal-audit-log.md

… proposal

Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru>

docs/proposals/proposal-audit-log.md

n1ru4l · 2024-06-19T09:56:01Z

@capaj I think there was a misunderstanding before, in which exact method the logging is added is not as important right now. We need a list of the event types, the data stored for that specific event, and a sample formatted sentence on how to display that data within the app for users. We can take the mutation resolvers as an entry point to locate the class method where the logging should be added for the actual implementation later on, and get a better idea of the data worth storing.

capaj · 2024-06-19T10:46:25Z

@n1ru4l the list of events I propose to log is here between lines 10 and 144:
https://github.com/kamilkisiela/graphql-hive/pull/4990/files#diff-8f8e57f328cf7f2227e74556e03115d1b53187395e84323c8bc3b9085916b6c9R10-R144

a sample formatted sentence on how to display that data within the app for users.

why is FE a necessary part of this task?
IMHO audit logging has TREMENDOUS value for the user of hive even if it is not displayed anywhere. User can always query their clickhouse on their own.

It was once mentioned, but I never thought it's part of this proposal. I can add it if you deem it is necessary and we need to implement it from the get got.
I would personally split it in two separate issues with two separate PRs, but if you think I can pull it off in a single PR fine by me.
It will take me like additional day just for the proposal to add this for all 120ish events we have listed.

the data stored for that specific event

this will take me like 2-3 days to add to the proposal. I need to go through each event, basically find where it is going to be called.
For me easiest way to gather this is by simply implementing it and then gathering it by parsing all the calls to logAuditEvent so we're crossing from proposal to implementation here.

EDIT: actually you mentioned FE once here https://guild-oss.slack.com/archives/C01E8ATBQGN/p1718615139510519?thread_ts=1718613813.068609&cid=C01E8ATBQGN

capaj · 2024-06-19T10:55:26Z

We can take the mutation resolvers as an entry point to locate the class method where the logging should be added for the actual implementation later on, and get a better idea of the data worth storing.

I was suggesting using an http middleware where mutation resolver names would be used as event names in our initial conversation on slack and you said we should rather use our bussinec logic classes here: https://guild-oss.slack.com/archives/C01E8ATBQGN/p1718614773106589?thread_ts=1718613813.068609&cid=C01E8ATBQGN

so that's why I went for the class method names rather than GQL mutation resolver names.

If you think we should rather use GQL mutation resolver names I am totally fine with that, In that case I would probably suggest we track almost all of them, maybe with exception of experimental__updateTargetSchemaComposition.
In details we would store the inputs for each resolver.

For example for event retireAppDeployment we would store RetireAppDeploymentInput in event_details

docs/proposals/proposal-audit-log.md

capaj · 2024-06-20T06:45:18Z

From what it seems to me there is misalignment between me and @kamilkisiela @n1ru4l on what the objective is for this issue.

They see it as fullstack solution that we can deploy and it will have a nice UI for the user to be able to search, filter, download and explore the audit logs.

I have never considered the UI part for this proposal.

Since the UI part is so important to both @kamilkisiela and @n1ru4l it's not productive to try to work on the proposal for anyone without the knowledge of actual usecases.
IMHO we should have a UI design done first or at least wireframes to show what is needed on FE.
This has to be done by someone who knows the requirements, ideally someone who speaks to users who asked for this to find out how they plan to use this feature.

I am a bit confused why anyone would think this task is ready for getting specced when @kamilkisiela admitted himself we do not have a list of filters from the UI: https://guild-oss.slack.com/archives/CAY2119MX/p1718801461050759?thread_ts=1718790068.341029&cid=CAY2119MX

Let's close this proposal until we have clearer requirements as in it's current form it's nowhere near acceptable for @n1ru4l and @kamilkisiela

capaj added the documentation Improvements or additions to documentation label Jun 18, 2024

capaj mentioned this pull request Jun 18, 2024

Audit log #1071

Open

n1ru4l reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Show resolved Hide resolved

n1ru4l reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

n1ru4l reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

n1ru4l reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

n1ru4l reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

n1ru4l reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

n1ru4l reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

capaj force-pushed the audit-log-wip branch from 2c88bc2 to 84e4723 Compare June 18, 2024 13:25

capaj force-pushed the audit-log-wip branch from 84e4723 to b6e97a3 Compare June 18, 2024 13:28

dimaMachina reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

dimaMachina reviewed Jun 18, 2024

View reviewed changes

scripts/get-services-outline.ts Outdated Show resolved Hide resolved

dimaMachina reviewed Jun 18, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

capaj and others added 5 commits June 19, 2024 11:13

docs: add proposal for audit log

11bc847

docs: remove a few methods we don't want to log

0ee70ff

docs: add methods from storage and remove unnecessary events from the…

eebd5fc

… proposal

docs: delete empty line

5ce97ba

Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru>

refactor: remove unnecessary condition

0e80dde

Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru>

capaj force-pushed the audit-log-wip branch from d3663cd to 0e80dde Compare June 19, 2024 09:13

capaj and others added 2 commits June 19, 2024 11:18

Update docs/proposals/proposal-audit-log.md

167231f

Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru>

add TTL to clikhouse schema

fb85c9a

n1ru4l reviewed Jun 19, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

n1ru4l reviewed Jun 19, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Show resolved Hide resolved

introduce AuditLog as singleton

6f29740

capaj force-pushed the audit-log-wip branch from 9312a38 to 6f29740 Compare June 19, 2024 10:30

capaj changed the title ~~Audit log wip~~ Audit log proposal wip Jun 19, 2024

add clickhouse indexes

e9dd957

n1ru4l reviewed Jun 19, 2024

View reviewed changes

docs/proposals/proposal-audit-log.md Outdated Show resolved Hide resolved

remove event_kind

9fcbb60

capaj closed this Jun 20, 2024

kamilkisiela deleted the audit-log-wip branch June 20, 2024 08:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Audit log proposal wip #4990

Audit log proposal wip #4990

capaj commented Jun 18, 2024

changeset-bot bot commented Jun 18, 2024 •

edited

Loading

github-actions bot commented Jun 18, 2024 •

edited

Loading

n1ru4l commented Jun 18, 2024 •

edited

Loading

capaj commented Jun 18, 2024

n1ru4l commented Jun 19, 2024

capaj commented Jun 19, 2024 •

edited

Loading

capaj commented Jun 19, 2024 •

edited

Loading

capaj commented Jun 20, 2024 •

edited

Loading

Audit log proposal wip #4990

Audit log proposal wip #4990

Conversation

capaj commented Jun 18, 2024

changeset-bot bot commented Jun 18, 2024 • edited Loading

⚠️ No Changeset found

github-actions bot commented Jun 18, 2024 • edited Loading

n1ru4l commented Jun 18, 2024 • edited Loading

capaj commented Jun 18, 2024

n1ru4l commented Jun 19, 2024

capaj commented Jun 19, 2024 • edited Loading

capaj commented Jun 19, 2024 • edited Loading

capaj commented Jun 20, 2024 • edited Loading

changeset-bot bot commented Jun 18, 2024 •

edited

Loading

github-actions bot commented Jun 18, 2024 •

edited

Loading

n1ru4l commented Jun 18, 2024 •

edited

Loading

capaj commented Jun 19, 2024 •

edited

Loading

capaj commented Jun 19, 2024 •

edited

Loading

capaj commented Jun 20, 2024 •

edited

Loading