Fix semantics and rename http flag

.github/workflows/proto-pr.yaml

@@ -50,6 +50,9 @@ jobs:
 
       - uses: bufbuild/buf-setup-action@3e33fea8596569a62fcaa33eb3880b6ac7098941 # tag=v1.9.0
 
+      - name: version
+        run: buf --version
+
       - name: Format
         run: buf format --diff --exit-code
 

.github/workflows/proto-push.yaml

@@ -53,6 +53,9 @@ jobs:
 
       - uses: bufbuild/buf-setup-action@3e33fea8596569a62fcaa33eb3880b6ac7098941 # tag=v1.9.0
 
+      - name: version
+        run: buf --version
+
       - name: Format
         run: buf format --diff --exit-code
 

README.md

@@ -90,7 +90,8 @@ Flags:
                                    to a remote gRPC endpoint. All runs all
                                    components.
       --log-level="info"           log level.
-      --port=":7070"               Port string for server
+      --http-address=":7070"       Address to bind HTTP server to.
+      --port=""                    (DEPRECATED) Use http-address instead.
       --cors-allowed-origins=CORS-ALLOWED-ORIGINS,...
                                    Allowed CORS origins.
       --otlp-address=STRING        OpenTelemetry collector address to send

deploy/dev.jsonnet

@@ -1,4 +1,4 @@
-function(agentVersion='v0.4.1', separateUI=true)
+function(agentVersion='v0.10.0-rc.0', separateUI=true)
   local ns = {
     apiVersion: 'v1',
     kind: 'Namespace',

deploy/lib/parca/parca.libsonnet

@@ -208,6 +208,8 @@ function(params) {
       args:
         [
           '/parca',
+          // http-address optionally specifies the TCP address for the server to listen on, in the form "host:port".
+          '--http-address=' + ':' + prc.config.port,
           '--config-path=/etc/parca/parca.yaml',
           '--log-level=' + prc.config.logLevel,
         ] +

pkg/parca/parca.go

@@ -76,10 +76,12 @@ const (
 )
 
 type Flags struct {
-	ConfigPath         string   `default:"parca.yaml" help:"Path to config file."`
-	Mode               string   `default:"all" enum:"all,scraper-only" help:"Scraper only runs a scraper that sends to a remote gRPC endpoint. All runs all components."`
-	LogLevel           string   `default:"info" enum:"error,warn,info,debug" help:"log level."`
-	Port               string   `default:":7070" help:"Port string for server"`
+	ConfigPath  string `default:"parca.yaml" help:"Path to config file."`
+	Mode        string `default:"all" enum:"all,scraper-only" help:"Scraper only runs a scraper that sends to a remote gRPC endpoint. All runs all components."`
+	LogLevel    string `default:"info" enum:"error,warn,info,debug" help:"log level."`
+	HTTPAddress string `default:":7070" help:"Address to bind HTTP server to."`
+	Port        string `default:"" help:"(DEPRECATED) Use http-address instead."`
+
 	CORSAllowedOrigins []string `help:"Allowed CORS origins."`
 	OTLPAddress        string   `help:"OpenTelemetry collector address to send traces to."`
 	Version            bool     `help:"Show application version."`
@@ -133,6 +135,11 @@ func Run(ctx context.Context, logger log.Logger, reg *prometheus.Registry, flags
 		defer closer()
 	}
 
+	if flags.Port != "" {
+		level.Warn(logger).Log("msg", "flag --port is deprecated, use --http-address instead")
+		flags.HTTPAddress = flags.Port
+	}
+
 	cfg, err := config.LoadFile(flags.ConfigPath)
 	if err != nil {
 		level.Error(logger).Log("msg", "failed to read config", "path", flags.ConfigPath)
@@ -409,7 +416,7 @@ func Run(ctx context.Context, logger log.Logger, reg *prometheus.Registry, flags
 			return parcaserver.ListenAndServe(
 				ctx,
 				logger,
-				flags.Port,
+				flags.HTTPAddress,
 				flags.CORSAllowedOrigins,
 				flags.PathPrefix,
 				server.RegisterableFunc(func(ctx context.Context, srv *grpc.Server, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) error {
@@ -603,7 +610,7 @@ func runScraper(
 				return parcaserver.ListenAndServe(
 					serveCtx,
 					logger,
-					flags.Port,
+					flags.HTTPAddress,
 					flags.CORSAllowedOrigins,
 					flags.PathPrefix,
 					server.RegisterableFunc(func(ctx context.Context, srv *grpc.Server, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) error {

pkg/server/server.go

@@ -89,8 +89,8 @@ func NewServer(reg *prometheus.Registry, version string) *Server {
 }
 
 // ListenAndServe starts the http grpc gateway server.
-func (s *Server) ListenAndServe(ctx context.Context, logger log.Logger, port string, allowedCORSOrigins []string, pathPrefix string, registerables ...Registerable) error {
-	level.Info(logger).Log("msg", "starting server", "addr", port)
+func (s *Server) ListenAndServe(ctx context.Context, logger log.Logger, addr string, allowedCORSOrigins []string, pathPrefix string, registerables ...Registerable) error {
+	level.Info(logger).Log("msg", "starting server", "addr", addr)
 	logLevel := "ERROR"
 
 	logOpts := []grpc_logging.Option{
@@ -135,7 +135,7 @@ func (s *Server) ListenAndServe(ctx context.Context, logger log.Logger, port str
 
 	grpcWebMux := runtime.NewServeMux()
 	for _, r := range registerables {
-		if err := r.Register(ctx, srv, grpcWebMux, port, opts); err != nil {
+		if err := r.Register(ctx, srv, grpcWebMux, addr, opts); err != nil {
 			return err
 		}
 	}
@@ -176,7 +176,7 @@ func (s *Server) ListenAndServe(ctx context.Context, logger log.Logger, port str
 	}
 
 	s.Server = http.Server{
-		Addr: port,
+		Addr: addr,
 		Handler: grpcHandlerFunc(
 			srv,
 			fallbackNotFound(internalMux, uiHandler),

ui/README.md

@@ -6,7 +6,7 @@ This is a [Create React App](https://create-react-app.dev/) project that utilize
 
 The React app requires an environment variable for the API endpoint so as to talk to the Parca backend. Create a file named `.env.local` in `packages/app/web/` to add the environment variable for the API endpoint.
 
-```
+```shell
 REACT_APP_PUBLIC_API_ENDPOINT=http://localhost:7070
 ```
 
@@ -46,8 +46,7 @@ make ui/build # yarn install && yarn build
 
 We embed the artifacts (the production build and its static assets) into the final binary distribution.
 See https://pkg.go.dev/embed for further details.
-
-Run following to build the `parca` binary with embedded assets.
+Run the following to build the `parca` binary with embedded assets.
 
 ```shell
 make build
@@ -63,7 +62,7 @@ You can set up a cluster and all else you need by simply running:
 make dev/up
 ```
 
-For a simple local development setup we use [Tilt](https://tilt.dev).
+For a simple local development setup, we use [Tilt](https://tilt.dev).
 
 ```shell
 tilt up
@@ -73,33 +72,33 @@ tilt up
 
 We have a feature flag system that allows you to enable or disable features for a user browser. It's a naive implementation based on browser local storage.
 
-#### Usage:
+### Usage
 
-```
+```js
 import useUIFeatureFlag from '@parca/functions/useUIFeatureFlag';
 
 const Header = () => {
   const isGreetingEnabled = useUIFeatureFlag('greeting');
   return (
     <div>
-      <img src="/logo.png" alt="Logo"/>
+      <img src="/logo.png" alt="Logo" />
       {isGreetingEnabled ? <h1>Hello!!!</h1> : null}
     </div>
   );
-}
+};
 ```
 
-For easy modification of the flag states, we added a two utility query params that can be used to control the feature flag state: `enable-ui-flag` and `disable-ui-flag`.
+For easy modification of the flag states, we added two utility query params that can be used to control the feature flag state: `enable-ui-flag` and `disable-ui-flag`.
 
 For example, if you want to enable the greeting feature for a browser, you can load the following URL:
 
-```
+```text
 http://localhost:3000/?enable-ui-flag=greeting
 ```
 
-Like wise, if you would like to disable the greeting feature for a browser, you can load the following URL:
+Likewise, if you would like to disable the greeting feature for a browser, you can load the following URL:
 
-```
+```text
 http://localhost:3000/?disable-ui-flag=greeting
 ```
 

ui/ui.go

@@ -17,7 +17,6 @@ import "embed"
 
 //nolint:typecheck
 //go:embed packages/app/web/build
-
 var FS embed.FS
 
 // NOTICE: Static HTML export of a Next.js app contains several files prefixed with _,