feat: implement GET /auth_logs/ and /auth_logs/{id}

ramirezj commented 3 months ago

Description

Implement GET /auth_logs and /auth_logs/{id} endpoints

Related Tickets & Documents

Close #27 , #28

Steps to Verify

Untested, insufficient data

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes introduce comprehensive enhancements to the documentation and implementation of authentication logs within the Kolide framework. This includes new SQL queries and BATS tests for retrieving and validating log data, alongside modifications to existing API documentation. These improvements aim to provide clearer insights into user authentication activities and streamline data management for enhanced security and compliance tracking.

Changes

Files	Change Summary
docs/coverage.md, docs/tables/kolide_auth_log.md	Updated status indicators for `/auth_logs` API and introduced detailed documentation for `kolide_auth_log`.
kolide/client/auth_log.go	Added structures and methods for handling authentication logs, including pagination and detailed log entries.
kolide/plugin.go	Introduced new table mapping for `kolide_auth_log`, enhancing the plugin's data management capabilities.
kolide/table_kolide_auth_log.go	Defined a plugin table for authentication events, including listing and retrieving logs with filtering options.
test/end-to-end/_query/kolide_auth_log.sql, test/end-to-end/_query/kolide_auth_log_by_id.sql	Added SQL queries for retrieving general and specific authentication logs.
test/end-to-end/_results/kolide_auth_log.bash	Introduced a Bash script for defining test results, with placeholders for future development.
test/end-to-end/kolide_auth_log.bats, test/end-to-end/kolide_auth_log_by_id.bats	New BATS test files validating query execution and result assertions for authentication logs.

Sequence Diagram(s)

sequenceDiagram
    participant Client as API Client
    participant Server as Kolide Server
    participant Database as Auth Log DB

    Client->>Server: Request authentication logs
    Server->>Database: Fetch logs
    Database-->>Server: Return log data
    Server-->>Client: Deliver logs

Assessment against linked issues

Objective	Addressed	Explanation
Retrieve authentication logs (#27)	✅
Improve logging and auditing features (#27)	✅
Provide clear documentation for logs (#27)	✅

Poem

🐰 In the meadow, I hop with glee,
New logs for all, so clear to see!
With queries and tests, oh what a delight,
Kolide's logs shine ever so bright!
A burrow of data, safe and sound,
For every login, our joy knows no bound! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.