go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/server/analytics/doc.go (about)

     1  // Copyright 2016 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package analytics provides a way to generate google analytics snippets.
    16  //
    17  // Usage as a server module:
    18  //
    19  //	func main() {
    20  //	  modules := []module.Module{
    21  //	    analytics.NewModuleFromFlags(),
    22  //	  }
    23  //	  server.Main(nil, modules, func(srv *server.Server) error {
    24  //	    srv.Routes.GET("/", ..., func(c *router.Context) {
    25  //	      templates.MustRender(c.Context, c.Writer, "page.html", templates.Args{
    26  //	        "GTagSnippet": analytics.GTagSnippet(c.Context),
    27  //	        ...
    28  //	      })
    29  //	    return nil
    30  //	  })
    31  //	  ...
    32  //	}
    33  //
    34  // templates/page.html:
    35  //
    36  //	<html>
    37  //	  <head>
    38  //	    {{.GTagSnippet}}
    39  //	    ...
    40  //	  </head>
    41  //	  <body>
    42  //	    ...
    43  //	  </body>
    44  //	</html>
    45  package analytics