Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(elk): add missing version field #760

Merged
merged 1 commit into from
Feb 26, 2025
Merged

Conversation

BlackHole1
Copy link
Contributor

@BlackHole1 BlackHole1 commented Feb 18, 2025

此字段在刚开始接入 es 时就已经存在(PR: #513). 因为 es 中设置了 dynamic: true 故一直没有报错, 但为了更好的健壮性, 对其进行补全.

不影响现有索引, 无需 reindex, 但如果企业是刚开始接入 cnpm, 那设置下会更好.

PTAL @Beace @fengmk2

Summary by CodeRabbit

  • New Features
    • Enhanced package management by adding version information to improve filtering and search capabilities. This update expands data handling without affecting existing functionality.

此字段在刚开始接入 es 时就已经存在(PR: cnpm#513). 因为 es 中设置了 `dynamic: true` 故一直没有报错,但为了更好的健壮性, 对其进行补全.

不影响现有索引, 无需 `reindex`, 但如果企业是刚开始接入 cnpm, 那设置下会更好.

Signed-off-by: Kevin Cui <[email protected]>
Copy link
Contributor

coderabbitai bot commented Feb 18, 2025

Walkthrough

The changes update the Elasticsearch index mapping for the cnpmcore_packages index by adding a new property named version to the package properties. This field is defined with a normalizer of raw and a type of keyword. Additionally, modifications to the index creation command in the Kibana dev tool section ensure that the new version field is included when creating or updating the index. These changes enhance the schema to store and query package version data without impacting existing functionality.

Changes

File Changes
docs/elasticsearch-setup.md Added the "version" field (with type: keyword and normalizer: raw) to the package properties in the index mapping for cnpmcore_packages. Updated index creation command.

Poem

I'm a rabbit, hopping with delight,
Seeing schemas updated and code looking bright,
A new "version" field now takes its stance,
In the index mapping—here's our chance!
With keywords and normalizers setting the pace,
I celebrate this change with a joyful embrace!
🥕🐇


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/elasticsearch-setup.md (1)

940-947: Ensure Consistency in Mapping Examples

In the earlier mapping snippet (lines 603–606) the "version" field is added under the package properties. However, in the second mapping example (the Kibana dev tool section), the new "version" field is missing. For clarity and to avoid potential confusion for new integrations, please update the second mapping snippet to include the "version" field. For example, after the "scope" field and before the "versions" field, you might add:

 "scope": {
   "normalizer": "raw",
   "type": "keyword"
 },
+"version": {
+  "normalizer": "raw",
+  "type": "keyword"
+},
 "versions": {
   "index": false,
   "type": "text"
 }

This will make both mapping examples consistent and reinforce the intended schema update.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 05b3b79 and 17be068.

📒 Files selected for processing (1)
  • docs/elasticsearch-setup.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: test-postgresql-fs-nfs (22, ubuntu-latest)
  • GitHub Check: test-mysql57-fs-nfs (22, ubuntu-latest)
  • GitHub Check: test-postgresql-fs-nfs (20, ubuntu-latest)
  • GitHub Check: test-mysql57-fs-nfs (20, ubuntu-latest)
  • GitHub Check: test-postgresql-fs-nfs (18, ubuntu-latest)
  • GitHub Check: test-mysql57-fs-nfs (18, ubuntu-latest)
  • GitHub Check: test-postgresql-fs-nfs (18.20.0, ubuntu-latest)
  • GitHub Check: Analyze (typescript)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: test-mysql57-fs-nfs (18.20.0, ubuntu-latest)
🔇 Additional comments (1)
docs/elasticsearch-setup.md (1)

603-606: New "version" Field Defined Correctly

The addition of the "version" field is implemented as intended, with a normalizer set to "raw" and the type defined as "keyword". This ensures that package version strings are stored exactly for efficient exact-match queries.

@fengmk2
Copy link
Member

fengmk2 commented Feb 18, 2025

@Beace 看看,没问题就合并了。

@Beace
Copy link
Contributor

Beace commented Feb 26, 2025

@Beace 看看,没问题就合并了。

LGTM. 这个没问题的

Copy link
Contributor

@Beace Beace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fengmk2 fengmk2 merged commit ae88145 into cnpm:master Feb 26, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants