Add linters to project

[shivanshuraj1333]

Enable linting for query-service package, usegolangci-lint, refer OTeL collector for reference, on how to enable it.

[Vivekcoder43]

Project Linting Setup

Installation

Install golangci-lint

First, you need to install golangci-lint. You can do this by running:

go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Configuration

Create a .golangci.yml file in the root of your project with the following content:

linters:
  enable:
    - errcheck
    - gofmt
    - gosimple
    - govet
    - staticcheck
    - structcheck
    - typecheck
    - unused
    - varcheck

run:
  timeout: 5m

Running the Linter

Add the following command to your Makefile to run golangci-lint:

lint:
    golangci-lint run

You can now run the linter using:

make lint

Continuous Integration

GitHub Actions Workflow

To ensure linting is performed on every push and pull request, create a GitHub Actions workflow file at .github/workflows/lint.yml:

name: Lint

on: [push, pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.16

      - name: Install golangci-lint
        run: |
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.42.1

      - name: Run golangci-lint
        run: golangci-lint run

Reach out to me for any additional information or queries

[shivanshuraj1333]

hey @Vivekcoder43 thanks for the GPT response, do you want to try implementing it for the pkg/query-service?
You can take some pointers from how it is configured for https://github.com/open-telemetry/opentelemetry-collector-contrib.
I have a PR that would resolve the issues that you'd encounter while running the lint.
Post that PR you can integrate the linter.

[Vivekcoder43]

hey @shivanshuraj1333 thanks for following up

I have a PR that would resolve the issues that you'd encounter while running the lint

Can you elaborate this

what are the issues you mean we get while running the lint , which PR you are referring to

[shivanshuraj1333]

#5505
Basically you don't need to fix the errors that you might get while running the linter.

[Vivekcoder43]

Awesome, thanks @shivanshuraj1333

[shivanshuraj1333]

@Vivekcoder43 are you stuck with something? Do you need help?

[Vivekcoder43]

@shivanshuraj1333 , actually I have windows system and came to know the docker standalone installation is not supported

Will arrange this and start working asap

[shivanshuraj1333]

https://docs.docker.com/desktop/install/windows-install/
Do you know if this isn't working?

TIP: If you've enough resources in you're laptop, you can dual-boot

[Vivekcoder43]

I already have docker desktop, installing wsl and will integrate that with docker and start working on that

Also I am working on a release blocker issue(my company ), so not up to speed

Expecting by EOD I can send a PR

[Vivekcoder43]

hi @shivanshuraj1333 , otel - migrator image is not running ,
sharing u relevant logs

2024-07-19 13:56:43 {"level":"error","timestamp":"2024-07-19T08:26:43.996Z","caller":"migrationmanager/manager.go:81","msg":"Failed to run migrations for migrator","component":"migrationmanager","migrator":"logs","error":"clickhouse migrate failed to run, error: code: 481, message: Cannot set modification time to file: /var/lib/clickhouse/store/34c/34cfbfe3-6b68-4426-8492-3a667e5b8610/tmp_insert_all_8_8_0/: , errno: 1, strerror: Operation not permitted in line 0: INSERT INTO schema_migrations (version, dirty, sequence) VALUES (1, 1, 1721377603958814657)","stacktrace":"github.com/SigNoz/signoz-otel-collector/migrationmanager.(*MigrationManager).Migrate\n\t/home/runner/work/signoz-otel-collector/signoz-otel-collector/migrationmanager/manager.go:81\nmain.main\n\t/home/runner/work/signoz-otel-collector/signoz-otel-collector/cmd/signozschemamigrator/migrate.go:126\nruntime.main\n\t/opt/hostedtoolcache/go/1.21.11/x64/src/runtime/proc.go:267"}
2024-07-19 13:56:43 {"level":"fatal","timestamp":"2024-07-19T08:26:43.996Z","caller":"signozschemamigrator/migrate.go:128","msg":"Failed to run migrations","component":"migrate cli","error":"clickhouse migrate failed to run, error: code: 481, message: Cannot set modification time to file: /var/lib/clickhouse/store/34c/34cfbfe3-6b68-4426-8492-3a667e5b8610/tmp_insert_all_8_8_0/: , errno: 1, strerror: Operation not permitted in line 0: INSERT INTO schema_migrations (version, dirty, sequence) VALUES (1, 1, 1721377603958814657)","stacktrace":"main.main\n\t/home/runner/work/signoz-otel-collector/signoz-otel-collector/cmd/signozschemamigrator/migrate.go:128\nruntime.main\n\t/opt/hostedtoolcache/go/1.21.11/x64/src/runtime/proc.go:267"}

[shivanshuraj1333]

Can you create an issue and add more details around it?
for the sake of this issue, I think you should be able to do the following even in the windows env:

1. clone the repo
2. setup golang
3. build pkg/query-service, basically, be able to run go build and get a binary for query-service
4. if all is done, run the linter
5. if you face issues, rebase to my branch from above PR
6. run the linter again
7. once everything is working, add the linter in github workflow