rmcguire/go-server-with-otel
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
go-server-with-otel/README.md
Ryan D McGuire b5b7ceb85a
Some checks failed
Build and Publish / release (push) Has been skipped
Details
Build and Publish / check-chart (push) Successful in 9s
Details
Build and Publish / helm-release (push) Has been cancelled
Details
add make rename support, update README
2025-03-31 16:09:22 -04:00

1.0 KiB
Raw Blame History

go-server-with-otel

Template for a go HTTP + GRPC server with OTEL support. Uses the go-app framework to easily bootstrap a new app with all the bells and whistles.

The provided proto returns a random fact, and serves only as a reference. It has support for grpc-gateway, and produces an openapi2/swagger spec for use with postman, etc..

Getting Started

  1. Rename your package using make rename NAME=my.gitremote.com/pathto/repo
  2. Review the config struct, adding any app-specific configuration
    1. This will be merged with the go-app config, giving logging/http/grpc configuration for free
  3. Generate a new json schema, for use with your config.yaml: make schema
    1. Ensure you have yaml+json tags
    2. The yaml-language-server lsp plugin for your favorite editor should pull in the schema using the comment in config.yaml
  4. Run make proto after updating proto changes, and add any
    1. paths under proto/ as necessary
  5. Implement your things
  6. Update parameters in .gitea/workflows/ci.yaml for your app