refactor(config): refactor config package #6782

grandwizard28 · 2025-01-08T21:31:55Z

Summary

refactor config package and get rid of upstream dependency on opentelemetry-collector

Important

Refactor configuration package to remove opentelemetry-collector dependency, introduce new config system, and update database and server initialization.

Configuration Refactor:
- Introduced new configuration system using factory and provider patterns in pkg/config and pkg/factory.
- Removed dependency on opentelemetry-collector.
- Added NewConfigFactory and NewProviderFactory for modular configuration.
Database and SQLStore:
- Refactored database initialization to use sqlstore and migrations.
- Added migration files for various components like agents, dashboards, integrations.
- Updated InitDB functions to use new sqlstore setup.
Server and Application:
- Updated Server initialization in server.go to use new configuration and SQL store.
- Refactored NewServer to integrate with signoz struct and new config system.
Web and HTTP:
- Introduced web package with router and noop providers.
- Added tests for web server configuration and routing.
Testing and Utilities:
- Updated test utilities to use new database setup.
- Added tests for new configuration and web server setup.

^{This description was created by}^{for 33bbc96. It will automatically update as commits are pushed.}

github-actions · 2025-01-08T21:32:10Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

github-actions · 2025-01-08T21:32:35Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Reviewed everything up to ae5ba2b in 1 minute and 44 seconds

More details

Looked at 1775 lines of code in 34 files
Skipped 0 files when reviewing.
Skipped posting 4 drafted comments based on config settings.

1. pkg/config/conf.go:28

Draft comment:
The comment on line 28 is misleading. It should clarify that the function merges the input configuration at a specified path within the current configuration.
Reason this comment was not posted:
Confidence changes required: 50%
The comment on line 28 incorrectly states that the function merges the current configuration with the input configuration. This is misleading as the function actually merges the input configuration at a specified path within the current configuration.

2. pkg/config/uri.go:10

Draft comment:
The comment on line 10 is misleading. It should clarify that the regex matches a specific format of URI, not the entire URI definition.
Reason this comment was not posted:
Confidence changes required: 50%
The comment on line 10 in pkg/config/uri.go is misleading. It states that the regex complies with the URI definition, but it only matches a specific format of URI. This should be clarified.

3. pkg/web/config.go:10

Draft comment:
The comment on line 10 is outdated. It should reflect that the Config satisfies the new config.Config interface, not confmap.Config.
Reason this comment was not posted:
Confidence changes required: 50%
The comment on line 10 in pkg/web/config.go is misleading. It states that the Config satisfies the confmap.Config interface, but it should be updated to reflect the new config.Config interface.

4. pkg/web/router/router.go:1

Draft comment:
Avoid using the component/index.tsx file structure approach, as it makes it difficult to debug and find components using global search tools like VS Code.
Reason this comment was not posted:
Comment was on unchanged code.

Workflow ID: wflow_XloMbrlpzoO23qs6

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

pkg/web/router/router.go

pkg/config/conf.go

github-actions · 2025-01-09T19:32:42Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on 4c94386 in 1 minute and 31 seconds

More details

Looked at 2466 lines of code in 40 files
Skipped 0 files when reviewing.
Skipped posting 4 drafted comments based on config settings.

1. pkg/signoz/signoz.go:24

Draft comment:
Add error handling for unrecognized cache providers to prevent potential nil pointer dereference.
Reason this comment was not posted:
Comment was not on a valid diff hunk.

2. pkg/signoz/signoz.go:46

Draft comment:
Add error handling for web initialization to prevent potential nil pointer dereference.
Reason this comment was not posted:
Comment was not on a valid diff hunk.

3. pkg/signoz/signoz.go:57

Draft comment:
Add error handling for sqlStore initialization to prevent potential nil pointer dereference.
Reason this comment was not posted:
Comment looked like it was already resolved.

4. pkg/query-service/app/server.go:27

Draft comment:
Avoid using the component/index.tsx file structure approach, as it makes it difficult to debug and find components using global search tools like VS Code.
Reason this comment was not posted:
Comment was not on a valid diff hunk.

Workflow ID: wflow_SdvgtI8IbXj32Z5C

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-09T20:04:00Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on 5d26d2b in 1 minute and 8 seconds

More details

Looked at 170 lines of code in 5 files
Skipped 0 files when reviewing.
Skipped posting 3 drafted comments based on config settings.

1. pkg/query-service/app/integrations/manager.go:126

Draft comment:
Removing error handling for NewInstalledIntegrationsSqliteRepo can lead to runtime errors if the database is not properly initialized. Consider re-adding error handling to ensure robustness.
Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable:

Without seeing NewInstalledIntegrationsSqliteRepo implementation, I can't be certain if it can fail. 2. The change suggests the function was modified to not return an error anymore. 3. If the function signature changed, then error handling would be unnecessary. 4. The code compiles, suggesting the function signature must have changed. 5. The PR author likely made this change intentionally after determining errors weren't possible.
I don't have access to the NewInstalledIntegrationsSqliteRepo implementation or its changes. The comment could be valid if that function can still fail at runtime.
Since the code compiles, the function signature must have changed to not return an error. The PR author likely determined error handling wasn't needed and simplified the API.
Without seeing the NewInstalledIntegrationsSqliteRepo implementation or its changes, I cannot verify if error handling is actually needed. The comment makes assumptions without full context.

2. pkg/query-service/app/integrations/test_utils.go:18

Draft comment:
Removing error handling for NewInstalledIntegrationsSqliteRepo can lead to runtime errors if the database is not properly initialized. Consider re-adding error handling to ensure robustness. This is also applicable in NewTestIntegrationsManager.
Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable:
This is a test utility function, and test utilities often simplify error handling for cleaner tests. The database is created using NewQueryServiceDBForTests which likely handles setup validation. Since this is test code, a panic on initialization failure is actually preferable to error propagation. The comment seems to be applying production code standards to test code.
I could be wrong about the database initialization being validated in NewQueryServiceDBForTests. There could be valid reasons to handle errors even in test code.
Even if the database initialization isn't fully validated elsewhere, having a test utility panic on setup failure is a valid and common pattern - it fails fast and makes test failures more obvious.
The comment should be deleted as it's applying overly strict standards to test code where simplified error handling is acceptable and often preferred.

3. pkg/query-service/app/integrations/manager.go:126

Draft comment:
The NewInstalledIntegrationsSqliteRepo function no longer returns an error, so the error handling in NewManager is unnecessary and should be removed.
Reason this comment was not posted:
Comment looked like it was already resolved.

Workflow ID: wflow_BOx5CKlqmlQpyfHW

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-09T20:32:52Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on 0c3af05 in 1 minute and 5 seconds

More details

Looked at 106 lines of code in 5 files
Skipped 0 files when reviewing.
Skipped posting 5 drafted comments based on config settings.

1. ee/query-service/app/server.go:210

Draft comment:
The removal of the 'engine' parameter from the NewLogParsingPipelinesController function call is consistent with the refactoring goal. Ensure that this parameter is not used elsewhere in the function.
Reason this comment was not posted:
Confidence changes required: 20%
The removal of the 'engine' parameter from the function signature is consistent across all instances where the function is called. This change aligns with the refactoring goal of removing unnecessary parameters.

2. pkg/query-service/agentConf/manager.go:42

Draft comment:
The removal of the 'DBEngine' field from the ManagerOptions struct is consistent with the refactoring goal. Ensure that this field is not used elsewhere in the code.
Reason this comment was not posted:
Confidence changes required: 20%
The removal of the 'DBEngine' field from the ManagerOptions struct is consistent across all instances where the struct is used. This change aligns with the refactoring goal of removing unnecessary fields.

3. pkg/query-service/app/logparsingpipeline/controller.go:30

Draft comment:
The removal of the 'engine' parameter from the NewLogParsingPipelinesController function call is consistent with the refactoring goal. Ensure that this parameter is not used elsewhere in the function.
Reason this comment was not posted:
Confidence changes required: 20%
The removal of the 'engine' parameter from the function signature is consistent across all instances where the function is called. This change aligns with the refactoring goal of removing unnecessary parameters.

4. pkg/query-service/tests/integration/logparsingpipeline_test.go:487

Draft comment:
The removal of the 'DBEngine' field from the ManagerOptions struct is consistent with the refactoring goal. Ensure that this field is not used elsewhere in the code.
Reason this comment was not posted:
Confidence changes required: 20%
The removal of the 'DBEngine' field from the ManagerOptions struct is consistent across all instances where the struct is used. This change aligns with the refactoring goal of removing unnecessary fields.

5. pkg/query-service/app/server.go:174

Draft comment:
Avoid using inline styles in React components. Use external stylesheets, CSS classes, or styled components instead. This is also applicable in other parts of the code where inline styles are used.
Reason this comment was not posted:
Comment was not on a valid diff hunk.

Workflow ID: wflow_8M11gtu6Fo1lD3Vp

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-09T21:02:27Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on e1cb905 in 38 seconds

More details

Looked at 241 lines of code in 5 files
Skipped 0 files when reviewing.
Skipped posting 3 drafted comments based on config settings.

1. pkg/sqlstore/config.go:36

Draft comment:
The increase in MaxOpenConns from 10 to 100 should be justified. Ensure the system can handle this increase without resource exhaustion.
Reason this comment was not posted:
Confidence changes required: 50%
The change in MaxOpenConns from 10 to 100 in pkg/sqlstore/config.go is significant and should be justified. Increasing the number of open connections can improve performance by allowing more concurrent database operations, but it can also lead to resource exhaustion if not managed properly. It's important to ensure that the system can handle this increase without negative side effects.

2. pkg/sqlstore/provider/sqlite/provider.go:33

Draft comment:
The log message includes ?_foreign_keys=true in the path, which might be misleading as it's not part of the actual connection string. Consider aligning the log message with the actual connection string or explaining the discrepancy.
Reason this comment was not posted:
Confidence changes required: 50%
The connection string for SQLite in pkg/sqlstore/provider/sqlite/provider.go includes ?_foreign_keys=true in the log message but not in the actual connection string. This could lead to confusion as the log message suggests foreign keys are enabled by default, which is not the case unless explicitly set in the connection string or via PRAGMA command.

3. pkg/sqlstore/provider/sqlite/provider.go:5

Draft comment:
Avoid using the component/index.tsx file structure approach, as it makes it difficult to debug and find components using global search tools.
Reason this comment was not posted:
Comment was on unchanged code.

Workflow ID: wflow_WX037G8SS8Azkp3M

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-09T21:05:35Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on 2060905 in 36 seconds

More details

Looked at 75 lines of code in 2 files
Skipped 0 files when reviewing.
Skipped posting 2 drafted comments based on config settings.

1. pkg/sqlstore/provider/sqlite/provider.go:30

Draft comment:
The refactor removed the explicit enabling of foreign key support using PRAGMA foreign_keys = ON;. Ensure that foreign key constraints are enforced as expected, as SQLite does not enable them by default.
Reason this comment was not posted:
Comment did not seem useful.

2. pkg/sqlstore/provider/sqlite/provider.go:30

Draft comment:
Avoid using inline styles in React components. Use external stylesheets, CSS classes, or styled components instead. This comment applies to other instances of inline styles in the code as well.
Reason this comment was not posted:
Comment was on unchanged code.

Workflow ID: wflow_iCItnw1uPH1tsZFP

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-11T12:54:09Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on e9decec in 37 seconds

More details

Looked at 76 lines of code in 4 files
Skipped 0 files when reviewing.
Skipped posting 4 drafted comments based on config settings.

1. pkg/query-service/utils/testutils.go:18

Draft comment:
The function NewQueryServiceDBForTests is a good refactor as it encapsulates the setup of a test database, including migrations and DAO initialization, providing a cleaner and more reliable test setup.
Reason this comment was not posted:
Confidence changes required: 0%
The function NewQueryServiceDBForTests in pkg/query-service/utils/testutils.go is responsible for setting up a test database. It creates a temporary SQLite database file, initializes the SQL store, runs migrations, and initializes the DAO and dashboards. This function is used in the test files to provide a test database instance. The refactoring seems to replace the previous NewTestSqliteDB function with this new function, which is more comprehensive and encapsulates the setup process better.

2. ee/query-service/app/server.go:206

Draft comment:
Refactored to use signoz.SqlStore.Provider().SqlxDB() for initializing cloudIntegrationsController, which centralizes database access and reduces redundancy.
Reason this comment was not posted:
Confidence changes required: 0%
The refactor in ee/query-service/app/server.go and pkg/query-service/app/server.go changes the way the cloudIntegrationsController is initialized. It now uses signoz.SqlStore.Provider().SqlxDB() instead of localDB. This change aligns with the refactor goal of removing upstream dependencies and centralizing the database access through signoz.SqlStore. This is a positive change as it reduces redundancy and potential inconsistencies in database access.

3. pkg/query-service/app/cloudintegrations/controller_test.go:15

Draft comment:
Replaced NewTestSqliteDB with NewQueryServiceDBForTests for better encapsulation of test database setup, improving test reliability.
Reason this comment was not posted:
Confidence changes required: 0%
The refactor in pkg/query-service/app/cloudintegrations/controller_test.go replaces NewTestSqliteDB with NewQueryServiceDBForTests. This change is consistent with the refactor goal of centralizing test database setup. The new function encapsulates the setup process better, including migrations and DAO initialization, which improves test reliability.

4. pkg/query-service/app/server.go:177

Draft comment:
Refactored to use signoz.SqlStore.Provider().SqlxDB() for initializing cloudIntegrationsController, aligning with the goal of centralizing database access.
Reason this comment was not posted:
Confidence changes required: 0%
The refactor in pkg/query-service/app/server.go changes the initialization of cloudIntegrationsController to use signoz.SqlStore.Provider().SqlxDB(). This aligns with the refactor goal of centralizing database access and removing upstream dependencies, which is a positive change for maintainability and consistency.

Workflow ID: wflow_5fjNCUa3QKXZ0UzS

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-14T09:54:10Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on 50a06d1 in 48 seconds

More details

Looked at 71 lines of code in 2 files
Skipped 0 files when reviewing.
Skipped posting 2 drafted comments based on config settings.

1. pkg/sqlstore/migrations/007_add_integrations.go:37

Draft comment:
Consider implementing the Down method to make the migration reversible. This will help in rolling back the migration if needed.
Reason this comment was not posted:
Comment was not on a valid diff hunk.

2. pkg/sqlstore/migrations/007_add_integrations.go:40

Draft comment:
Do not add non-ClickHouse related functions to the ClickHouseReader interface. Use the DAO in the telemetry instance to access such information instead.
Reason this comment was not posted:
Comment was not on a valid diff hunk.

Workflow ID: wflow_DU2eZElvH4qeMJOr

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-14T14:28:41Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

github-actions · 2025-01-14T14:29:02Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on e35d1c2 in 1 minute and 26 seconds

More details

Looked at 2165 lines of code in 41 files
Skipped 0 files when reviewing.
Skipped posting 6 drafted comments based on config settings.

1. ee/query-service/app/server.go:115

Draft comment:
The refactoring replaces SqlStore.Provider().SqlxDB() with SQLStore.SQLxDB(). Ensure that this change is consistent across the codebase and aligns with the refactoring goal to remove upstream dependencies.
Reason this comment was not posted:
Confidence changes required: 20%
The refactoring seems to have removed the SqlStore.Provider().SqlxDB() calls and replaced them with SQLStore.SQLxDB(). This change is consistent across the files and aligns with the refactoring goal to remove upstream dependencies.

2. ee/query-service/main.go:148

Draft comment:
The introduction of the instrumentation package and its usage to create an Instrumentation instance is a good practice. It modularizes the code and separates concerns.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring introduces a new instrumentation package and uses it to create an Instrumentation instance. This is a good practice as it modularizes the code and separates concerns.

3. pkg/cache/config.go:28

Draft comment:
The introduction of the factory package to handle configuration and provider creation centralizes the creation logic and makes the code more maintainable.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring introduces a new factory package to handle configuration and provider creation. This is a good practice as it centralizes the creation logic and makes the code more maintainable.

4. pkg/sqlstore/config.go:30

Draft comment:
The introduction of the factory package to handle configuration and provider creation centralizes the creation logic and makes the code more maintainable.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring introduces a new factory package to handle configuration and provider creation. This is a good practice as it centralizes the creation logic and makes the code more maintainable.

5. pkg/web/config.go:18

Draft comment:
The introduction of the factory package to handle configuration and provider creation centralizes the creation logic and makes the code more maintainable.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring introduces a new factory package to handle configuration and provider creation. This is a good practice as it centralizes the creation logic and makes the code more maintainable.

6. pkg/signoz/config.go:22

Draft comment:
The introduction of the factory package to handle configuration and provider creation centralizes the creation logic and makes the code more maintainable.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring introduces a new factory package to handle configuration and provider creation. This is a good practice as it centralizes the creation logic and makes the code more maintainable.

Workflow ID: wflow_B18PCoTALM59wbck

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev

👍 Looks good to me! Incremental review on 288747a in 1 minute and 41 seconds

More details

Looked at 2165 lines of code in 41 files
Skipped 0 files when reviewing.
Skipped posting 6 drafted comments based on config settings.

1. ee/query-service/app/server.go:115

Draft comment:
Refactored to use signoz.SQLStore.SQLxDB() instead of signoz.SqlStore.Provider().SqlxDB(), which aligns with the refactoring goal to remove the dependency on opentelemetry-collector. This change is applied consistently across the files.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring of the NewServer function in ee/query-service/app/server.go and pkg/query-service/app/server.go is consistent with the intent to remove the dependency on opentelemetry-collector. The changes involve using signoz.SQLStore.SQLxDB() instead of signoz.SqlStore.Provider().SqlxDB(), which aligns with the refactoring goal. This change is applied consistently across the files.

2. pkg/query-service/main.go:91

Draft comment:
Refactored to initialize instrumentation and signoz using the new factory pattern, which aligns with the refactoring goal to remove the dependency on opentelemetry-collector.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring in pkg/query-service/main.go and ee/query-service/main.go involves initializing the instrumentation and signoz instances with the new factory pattern. This change is consistent with the refactoring goal to remove the dependency on opentelemetry-collector. The initialization of instrumentation and signoz is done using the new NewProviderFactories method, which is a part of the refactoring.

3. pkg/cache/provider/memory/memory.go:18

Draft comment:
Introduced a new factory pattern for creating cache providers using NewFactory, which aligns with the refactoring goal to remove the dependency on opentelemetry-collector.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring in pkg/cache/provider/memory/memory.go introduces a new factory pattern for creating cache providers. This change is consistent with the refactoring goal to remove the dependency on opentelemetry-collector. The NewFactory function is used to create a new provider factory for the memory cache, which aligns with the new factory pattern.

4. pkg/sqlstore/provider/sqlite/sqlite.go:23

Draft comment:
Introduced a new factory pattern for creating SQL store providers using NewFactory, which aligns with the refactoring goal to remove the dependency on opentelemetry-collector.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring in pkg/sqlstore/provider/sqlite/sqlite.go introduces a new factory pattern for creating SQL store providers. This change is consistent with the refactoring goal to remove the dependency on opentelemetry-collector. The NewFactory function is used to create a new provider factory for the SQLite provider, which aligns with the new factory pattern.

5. pkg/sqlstore/migrations/migrations.go:19

Draft comment:
Refactored to use the new factory pattern for creating migration instances using NamedMap, which aligns with the refactoring goal to remove the dependency on opentelemetry-collector.
Reason this comment was not posted:
Confidence changes required: 10%
The refactoring in pkg/sqlstore/migrations/migrations.go involves using the new factory pattern for creating migration instances. This change is consistent with the refactoring goal to remove the dependency on opentelemetry-collector. The New function now uses the NamedMap to get migration factories, which aligns with the new factory pattern.

6. pkg/query-service/app/server.go:98

Draft comment:
Avoid using inline styles in React components. Use external stylesheets, CSS classes, or styled components instead. This is also applicable at line 115, 153, 170, and 233.
Reason this comment was not posted:
Comment was on unchanged code.

Workflow ID: wflow_Nm8s5l6BS2KSoR9s

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

github-actions · 2025-01-14T14:33:37Z

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

ellipsis-dev

👍 Looks good to me! Incremental review on 6a7975a in 51 seconds

More details

Looked at 216 lines of code in 4 files
Skipped 0 files when reviewing.
Skipped posting 2 drafted comments based on config settings.

1. ee/query-service/main.go:94

Draft comment:
The removal of the enableQueryServiceLogOTLPExport flag and related logic changes the functionality. Ensure this is intended and documented.
Reason this comment was not posted:
Confidence changes required: 50%
The PR refactors the logging setup by removing the custom initialization and using the logger from the instrumentation package. This is a good change as it centralizes logging configuration. However, the removal of the enableQueryServiceLogOTLPExport flag and related logic should be noted as it changes the functionality.

2. pkg/query-service/main.go:87

Draft comment:
The removal of the initZapLog function changes the logging setup. Ensure this is intended and documented.
Reason this comment was not posted:
Confidence changes required: 50%
The PR refactors the logging setup by removing the custom initialization and using the logger from the instrumentation package. This is a good change as it centralizes logging configuration. However, the removal of the initZapLog function should be noted as it changes the logging setup.

Workflow ID: wflow_QCSU5FCHm6TrL9Jd

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

pkg/web/provider/router/router.go

+	path := filepath.Join(web.config.Directory, req.URL.Path)
+
+	// check whether a file exists or is a directory at the given path
+	fi, err := os.Stat(path)


To fix the problem, we need to ensure that the user-provided path does not contain any path separators or sequences that could lead to directory traversal. We can achieve this by validating the req.URL.Path before using it to construct the file path. Specifically, we should:

Check that the path does not contain any .. sequences.

Ensure that the path is within the intended directory by resolving the absolute path and verifying it.

ellipsis-dev

👍 Looks good to me! Incremental review on 76d23b1 in 1 minute and 5 seconds

More details

Looked at 243 lines of code in 8 files
Skipped 0 files when reviewing.
Skipped posting 2 drafted comments based on config settings.

1. pkg/sqlstore/config.go:11

Draft comment:
The removal of the PostgresConfig struct is a breaking change. Ensure that there are no dependencies on PostgreSQL elsewhere in the codebase.
Reason this comment was not posted:
Comment did not seem useful.

2. pkg/instrumentation/instrumentation.go:23

Draft comment:
The ToProviderSettings method should not be part of the ClickHouseReader interface if it were present. However, since ClickHouseReader is not in this code, this rule does not apply here.
Reason this comment was not posted:
Confidence changes required: 50%
The ToProviderSettings method in the Instrumentation interface and its implementations is not related to ClickHouse, so it should not be part of the ClickHouseReader interface. However, since the ClickHouseReader interface is not present in the provided code, this rule does not apply here. The method is correctly placed in the Instrumentation interface.

Workflow ID: wflow_zqY3KtxXAdgGZ8vI

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev

❌ Changes requested. Incremental review on 33bbc96 in 2 minutes and 32 seconds

More details

Looked at 693 lines of code in 14 files
Skipped 0 files when reviewing.
Skipped posting 1 drafted comments based on config settings.

1. pkg/query-service/main.go:76

Draft comment:
The fmt.Println(err, err.Error()) line is redundant because zap.L().Fatal already logs the error. Consider removing this line to clean up the code.
Reason this comment was not posted:
Marked as duplicate.

Workflow ID: wflow_rqSRuzTqbaLxkmsw

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2025-01-14T19:06:56Z

ee/query-service/main.go

-	signoz, err := signoz.New(config, skipWebFrontend)
+	instrumentation, err := instrumentation.New(context.Background(), pkgversion.Build{}, config.Instrumentation)
+	if err != nil {
+		fmt.Println(err, err.Error())


The fmt.Println(err, err.Error()) line is redundant because zap.L().Fatal already logs the error. Consider removing this line to clean up the code.

nityanandagohain · 2025-01-15T04:19:32Z

This is a very big PR to review. Can it be broken down to smaller individual parts which can be reviewed ?

ellipsis-dev bot reviewed Jan 8, 2025

View reviewed changes

github-advanced-security bot found potential problems Jan 8, 2025

View reviewed changes

pkg/web/router/router.go Fixed Show fixed Hide fixed

vikrantgupta25 reviewed Jan 9, 2025

View reviewed changes

pkg/config/conf.go Outdated Show resolved Hide resolved

vikrantgupta25 previously approved these changes Jan 9, 2025

View reviewed changes

grandwizard28 dismissed vikrantgupta25’s stale review via 4c94386 January 9, 2025 19:31

ellipsis-dev bot reviewed Jan 9, 2025

View reviewed changes

grandwizard28 force-pushed the pkg/config branch from 2060905 to e9decec Compare January 11, 2025 12:53

ellipsis-dev bot reviewed Jan 11, 2025

View reviewed changes

ellipsis-dev bot reviewed Jan 14, 2025

View reviewed changes

grandwizard28 added 8 commits January 14, 2025 19:58

refactor(config): refactor config package

cf8c7d7

refactor(migrations): move migrations into a single package

25f1cb7

fix(tests): fix unit tests

96fb94a

feat(signoz): remove references to sqlite

6347933

feat(signoz): make mattn the permanent driver

3b2b917

feat(signoz): refactor connection config struct

a8136dd

ci(git): rebase with main

39e8223

feat(migrations): add cloud integrations

67034a5

feat(factory): embrace the factory pattern

288747a

grandwizard28 force-pushed the pkg/config branch from e35d1c2 to 288747a Compare January 14, 2025 14:28

ellipsis-dev bot reviewed Jan 14, 2025

View reviewed changes

feat(instrumentation): move to instrumentation package

6a7975a

ellipsis-dev bot reviewed Jan 14, 2025

View reviewed changes

github-advanced-security bot found potential problems Jan 14, 2025

View reviewed changes

grandwizard28 requested a review from nityanandagohain January 14, 2025 14:41

feat(instrumentation): add a test instrumentation package

76d23b1

ellipsis-dev bot reviewed Jan 14, 2025

View reviewed changes

feat(instrumentation): initialize instrumentation

33bbc96

ellipsis-dev bot reviewed Jan 14, 2025

View reviewed changes

@@ -76,2 +76,8 @@
             func (web *router) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
+            	// Validate the URL path to prevent directory traversal
+            	if strings.Contains(req.URL.Path, "..") {
+            		http.Error(rw, "Invalid file path", http.StatusBadRequest)
+            		return
+            	}
             	// Join internally call path.Clean to prevent directory traversal
@@ -79,4 +85,11 @@
+            	// Ensure the resolved path is within the web.config.Directory
+            	absPath, err := filepath.Abs(path)
+            	if err != nil || !strings.HasPrefix(absPath, web.config.Directory) {
+            		http.Error(rw, "Invalid file path", http.StatusBadRequest)
+            		return
+            	}
             	// check whether a file exists or is a directory at the given path
-            	fi, err := os.Stat(path)
+            	fi, err := os.Stat(absPath)
             	if os.IsNotExist(err) || fi.IsDir() {

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(config): refactor config package #6782

refactor(config): refactor config package #6782

grandwizard28 commented Jan 8, 2025 •

edited by ellipsis-dev bot

Loading

github-actions bot commented Jan 8, 2025

github-actions bot commented Jan 8, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 11, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 14, 2025

ellipsis-dev bot left a comment

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

ellipsis-dev bot left a comment

ellipsis-dev bot left a comment

github-actions bot commented Jan 14, 2025

ellipsis-dev bot left a comment

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

ellipsis-dev bot left a comment

ellipsis-dev bot left a comment

ellipsis-dev bot Jan 14, 2025

nityanandagohain commented Jan 15, 2025

refactor(config): refactor config package #6782

Are you sure you want to change the base?

refactor(config): refactor config package #6782

Conversation

grandwizard28 commented Jan 8, 2025 • edited by ellipsis-dev bot Loading

Summary

github-actions bot commented Jan 8, 2025

github-actions bot commented Jan 8, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 9, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 11, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 14, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 14, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Jan 14, 2025

Choose a reason for hiding this comment

nityanandagohain commented Jan 15, 2025

grandwizard28 commented Jan 8, 2025 •

edited by ellipsis-dev bot

Loading