File: templates.go

package info (click to toggle)
golang-opentelemetry-contrib 0.56.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,884 kB
  • sloc: makefile: 278; sh: 211; sed: 1
file content (90 lines) | stat: -rw-r--r-- 2,474 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

// Copyright 2017, OpenCensus Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

package zpages // import "go.opentelemetry.io/contrib/zpages"

import (
	"fmt"
	"html/template"
	"io"
	"log"

	"go.opentelemetry.io/contrib/zpages/internal"
)

var (
	templateFunctions = template.FuncMap{
		"even":    even,
		"spanRow": spanRowFormatter,
	}
	headerTemplate       = parseTemplate("header")
	summaryTableTemplate = parseTemplate("summary")
	tracesTableTemplate  = parseTemplate("traces")
	footerTemplate       = parseTemplate("footer")
)

// headerData contains data for the header template.
type headerData struct {
	Title string
}

func parseTemplate(name string) *template.Template {
	f, err := internal.Templates.Open("templates/" + name + ".html")
	if err != nil {
		log.Panicf("%v: %v", name, err) // nolint: revive  // Called during initialization.
	}
	defer func() {
		if err = f.Close(); err != nil {
			log.Panicf("%v: %v", name, err) // nolint: revive  // Called during initialization.
		}
	}()
	text, err := io.ReadAll(f)
	if err != nil {
		log.Panicf("%v: %v", name, err) // nolint: revive  // Called during initialization.
	}
	return template.Must(template.New(name).Funcs(templateFunctions).Parse(string(text)))
}

func spanRowFormatter(r spanRow) template.HTML {
	if !r.SpanContext.IsValid() {
		return ""
	}
	col := "black"
	if r.SpanContext.IsSampled() {
		col = "blue"
	}

	tpl := fmt.Sprintf(
		`trace_id: <b style="color:%s">%s</b> span_id: %s`,
		col,
		r.SpanContext.TraceID(),
		r.SpanContext.SpanID(),
	)
	if r.ParentSpanContext.IsValid() {
		tpl += fmt.Sprintf(` parent_span_id: %s`, r.ParentSpanContext.SpanID())
	}

	//nolint:gosec // G203: None of the dynamic attributes (TraceID/SpanID) can
	// contain characters that need escaping so this lint issue is a false
	// positive.
	return template.HTML(tpl)
}

func even(x int) bool {
	return x%2 == 0
}