Realm
@@ -115,13 +120,13 @@ const Content = () => {
Home
- {up.map((path, index) => (
-
-
- {path}
-
-
- ))}
+ {up.map((path, index) => {
+ return (
+
+ {path}
+
+ );
+ })}
{directories.length > 0 && }
diff --git a/http/realm-ui/src/components/side-nav.tsx b/http/realm-ui/src/components/side-nav.tsx
index 95e4df7..59c0fb7 100644
--- a/http/realm-ui/src/components/side-nav.tsx
+++ b/http/realm-ui/src/components/side-nav.tsx
@@ -8,7 +8,7 @@ export const SideNav = ({ directories }: { directories: string[] }) => {
{directories.map((curChamber) => {
- return
@@ -17,9 +17,9 @@ export const SideNav = ({ directories }: { directories: string[] }) => {
};
const Item = ({ directory }: { directory: string }) => {
- const to = useHref(directory, { relative: 'path' });
+ const href = useHref(directory, { relative: 'path' });
return (
-
+
{directory}
);
diff --git a/http/realm-ui/tsconfig.json b/http/realm-ui/tsconfig.json
index 7dc99c6..761deb7 100644
--- a/http/realm-ui/tsconfig.json
+++ b/http/realm-ui/tsconfig.json
@@ -23,8 +23,7 @@
"noFallthroughCasesInSwitch": true
},
"include": [
- "src",
- "vite.config.ts"
+ "src"
],
"references": [
{
diff --git a/main.go b/main.go
index 66fac04..43bd770 100644
--- a/main.go
+++ b/main.go
@@ -5,7 +5,7 @@ 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
+ 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,
diff --git a/pkg/storage/bigcache.go b/pkg/storage/bigcache.go
index ebea443..e6e114a 100644
--- a/pkg/storage/bigcache.go
+++ b/pkg/storage/bigcache.go
@@ -12,10 +12,14 @@ import (
"github.com/allegro/bigcache/v3"
"github.com/hashicorp/go-hclog"
+ "go.opentelemetry.io/otel"
+ "go.opentelemetry.io/otel/attribute"
+ "go.opentelemetry.io/otel/trace"
)
type BigCacheStorage struct {
underlying *bigcache.BigCache
+ tracer trace.Tracer
}
var (
@@ -71,14 +75,18 @@ func NewBigCacheStorage(config map[string]string) (Storage, error) {
if err != nil {
return nil, err
}
+ tracer := otel.Tracer("github.com/steviebps/realm")
return &BigCacheStorage{
underlying: cache,
+ tracer: tracer,
}, nil
}
func (f *BigCacheStorage) Get(ctx context.Context, logicalPath string) (*StorageEntry, error) {
logger := hclog.FromContext(ctx).ResetNamed("bigcache")
+ ctx, span := f.tracer.Start(ctx, "BigCacheStorage Get", trace.WithAttributes(attribute.String("logicalPath", logicalPath)))
+ defer span.End()
logger.Debug("get operation", "logicalPath", logicalPath)
if err := ValidatePath(logicalPath); err != nil {
@@ -105,6 +113,8 @@ func (f *BigCacheStorage) Get(ctx context.Context, logicalPath string) (*Storage
func (f *BigCacheStorage) Put(ctx context.Context, e StorageEntry) error {
logger := hclog.FromContext(ctx).ResetNamed("bigcache")
+ ctx, span := f.tracer.Start(ctx, "BigCacheStorage Put", trace.WithAttributes(attribute.String("entry.key", e.Key)))
+ defer span.End()
logger.Debug("put operation", "logicalPath", e.Key)
if err := ValidatePath(e.Key); err != nil {
@@ -123,6 +133,8 @@ func (f *BigCacheStorage) Put(ctx context.Context, e StorageEntry) error {
func (f *BigCacheStorage) Delete(ctx context.Context, logicalPath string) error {
logger := hclog.FromContext(ctx).ResetNamed("bigcache")
+ ctx, span := f.tracer.Start(ctx, "BigCacheStorage Delete", trace.WithAttributes(attribute.String("logicalPath", logicalPath)))
+ defer span.End()
logger.Debug("delete operation", "logicalPath", logicalPath)
if err := ValidatePath(logicalPath); err != nil {
@@ -141,6 +153,8 @@ func (f *BigCacheStorage) Delete(ctx context.Context, logicalPath string) error
func (f *BigCacheStorage) List(ctx context.Context, prefix string) ([]string, error) {
logger := hclog.FromContext(ctx).ResetNamed("bigcache")
+ ctx, span := f.tracer.Start(ctx, "BigCacheStorage List", trace.WithAttributes(attribute.String("prefix", prefix)))
+ defer span.End()
logger.Debug("list operation", "prefix", prefix)
if err := ValidatePath(prefix); err != nil {
diff --git a/pkg/storage/cacheable.go b/pkg/storage/cacheable.go
index 3c112e6..a20c7f5 100644
--- a/pkg/storage/cacheable.go
+++ b/pkg/storage/cacheable.go
@@ -6,6 +6,9 @@ import (
"fmt"
"github.com/hashicorp/go-hclog"
+ "go.opentelemetry.io/otel"
+ "go.opentelemetry.io/otel/attribute"
+ "go.opentelemetry.io/otel/trace"
)
// CacheableStorage is a wrapper storage used for providing a write-through cache.
@@ -14,6 +17,7 @@ import (
type CacheableStorage struct {
cache Storage
source Storage
+ tracer trace.Tracer
}
var (
@@ -29,6 +33,7 @@ func NewCacheableStorage(cache Storage, source Storage) (Storage, error) {
return &CacheableStorage{
cache: cache,
source: source,
+ tracer: otel.Tracer("github.com/steviebps/realm"),
}, nil
}
@@ -65,6 +70,8 @@ func NewCacheableStorageWithConf(conf map[string]string) (Storage, error) {
func (c *CacheableStorage) Get(ctx context.Context, logicalPath string) (*StorageEntry, error) {
logger := hclog.FromContext(ctx).ResetNamed("cacheable")
+ ctx, span := c.tracer.Start(ctx, "CacheableStorage Get", trace.WithAttributes(attribute.String("logicalPath", logicalPath)))
+ defer span.End()
logger.Debug("get operation", "logicalPath", logicalPath)
entry, err := c.cache.Get(ctx, logicalPath)
@@ -72,6 +79,7 @@ func (c *CacheableStorage) Get(ctx context.Context, logicalPath string) (*Storag
var nfError *NotFoundError
// cache layer is expected to have missing records so let's only log other errors
if errors.As(err, &nfError) {
+ span.SetAttributes(attribute.Bool("cache miss", true))
logger.Debug("cache", "miss", err.Error())
} else {
logger.Error("cache", "error", err.Error())
@@ -97,6 +105,8 @@ func (c *CacheableStorage) Get(ctx context.Context, logicalPath string) (*Storag
func (c *CacheableStorage) Put(ctx context.Context, e StorageEntry) error {
logger := hclog.FromContext(ctx).ResetNamed("cacheable")
+ ctx, span := c.tracer.Start(ctx, "CacheableStorage Put", trace.WithAttributes(attribute.String("entry.key", e.Key)))
+ defer span.End()
logger.Debug("put operation", "logicalPath", e.Key)
err := c.source.Put(ctx, e)
@@ -109,6 +119,8 @@ func (c *CacheableStorage) Put(ctx context.Context, e StorageEntry) error {
func (c *CacheableStorage) Delete(ctx context.Context, logicalPath string) error {
logger := hclog.FromContext(ctx).ResetNamed("cacheable")
+ ctx, span := c.tracer.Start(ctx, "CacheableStorage Delete", trace.WithAttributes(attribute.String("logicalPath", logicalPath)))
+ defer span.End()
logger.Debug("delete operation", "logicalPath", logicalPath)
err := c.source.Delete(ctx, logicalPath)
@@ -121,6 +133,8 @@ func (c *CacheableStorage) Delete(ctx context.Context, logicalPath string) error
func (c *CacheableStorage) List(ctx context.Context, prefix string) ([]string, error) {
logger := hclog.FromContext(ctx).ResetNamed("cacheable")
+ ctx, span := c.tracer.Start(ctx, "CacheableStorage List", trace.WithAttributes(attribute.String("prefix", prefix)))
+ defer span.End()
logger.Debug("list operation", "prefix", prefix)
return c.source.List(ctx, prefix)
}
diff --git a/pkg/storage/file.go b/pkg/storage/file.go
index 782486f..8d6fda9 100644
--- a/pkg/storage/file.go
+++ b/pkg/storage/file.go
@@ -93,7 +93,7 @@ func (f *FileStorage) Put(ctx context.Context, e StorageEntry) error {
return err
}
- return utils.WriteInterfaceWith(file, e.Value, true)
+ return utils.WriteInterfaceWith(file, e.Value, false)
}
func (f *FileStorage) Delete(ctx context.Context, logicalPath string) error {
diff --git a/pkg/storage/gcs.go b/pkg/storage/gcs.go
index 7f92e9f..a4c704a 100644
--- a/pkg/storage/gcs.go
+++ b/pkg/storage/gcs.go
@@ -1,10 +1,10 @@
package storage
import (
- "bytes"
"context"
"crypto/md5"
"fmt"
+ "io"
"path"
"sort"
"strings"
@@ -53,16 +53,16 @@ func (s *GCSStorage) Get(ctx context.Context, logicalPath string) (*StorageEntry
p, key := s.expandPath(logicalPath + gcsEntryKey)
r, err := s.client.Bucket(s.bucket).Object(path.Join(p, key)).NewReader(ctx)
- if err == gcs.ErrObjectNotExist {
- return nil, &NotFoundError{logicalPath}
- }
if err != nil {
+ if err == gcs.ErrObjectNotExist {
+ return nil, &NotFoundError{logicalPath}
+ }
return nil, err
}
defer r.Close()
- buf := new(bytes.Buffer)
- if _, err := buf.ReadFrom(r); err != nil {
+ value, err := io.ReadAll(r)
+ if err != nil {
return nil, err
}
@@ -72,7 +72,7 @@ func (s *GCSStorage) Get(ctx context.Context, logicalPath string) (*StorageEntry
default:
}
- return &StorageEntry{Key: logicalPath, Value: buf.Bytes()}, nil
+ return &StorageEntry{Key: logicalPath, Value: value}, nil
}
func (s *GCSStorage) Put(ctx context.Context, e StorageEntry) (retErr error) {
@@ -94,6 +94,7 @@ func (s *GCSStorage) Put(ctx context.Context, e StorageEntry) (retErr error) {
w := s.client.Bucket(s.bucket).Object(path.Join(p, key)).NewWriter(ctx)
md5Array := md5.Sum(e.Value)
w.MD5 = md5Array[:]
+ w.ContentType = "application/json"
if _, err := w.Write(e.Value); err != nil {
return fmt.Errorf("failed to put: %w", err)
diff --git a/pkg/storage/inheritable.go b/pkg/storage/inheritable.go
index 717dde1..d765239 100644
--- a/pkg/storage/inheritable.go
+++ b/pkg/storage/inheritable.go
@@ -10,10 +10,14 @@ import (
"github.com/hashicorp/go-hclog"
realm "github.com/steviebps/realm/pkg"
"github.com/steviebps/realm/utils"
+ "go.opentelemetry.io/otel"
+ "go.opentelemetry.io/otel/attribute"
+ "go.opentelemetry.io/otel/trace"
)
type InheritableStorage struct {
source Storage
+ tracer trace.Tracer
}
var (
@@ -24,25 +28,28 @@ var (
func NewInheritableStorage(source Storage) (Storage, error) {
return &InheritableStorage{
source: source,
+ tracer: otel.Tracer("github.com/steviebps/realm"),
}, nil
}
func (s *InheritableStorage) Get(ctx context.Context, logicalPath string) (*StorageEntry, error) {
logger := hclog.FromContext(ctx).ResetNamed("inheritable")
+ ctx, span := s.tracer.Start(ctx, "InheritableStorage Get", trace.WithAttributes(attribute.String("logicalPath", logicalPath)))
+ defer span.End()
logger.Debug("get operation", "logicalPath", logicalPath)
if err := ValidatePath(logicalPath); err != nil {
return nil, err
}
- // ensure the leaf of the path exists before retrieving its parents
+ // ensure the last entry of the path exists before retrieving its parents
leafEntry, err := s.source.Get(ctx, logicalPath)
if err != nil {
return nil, err
}
leaf := &realm.Chamber{}
- if err := json.Unmarshal([]byte(leafEntry.Value), leaf); err != nil {
+ if err := json.Unmarshal(leafEntry.Value, leaf); err != nil {
return nil, err
}
@@ -63,7 +70,7 @@ func (s *InheritableStorage) Get(ctx context.Context, logicalPath string) (*Stor
}
curChamber := &realm.Chamber{Rules: map[string]*realm.OverrideableRule{}}
- if err := json.Unmarshal([]byte(entry.Value), curChamber); err != nil {
+ if err := json.Unmarshal(entry.Value, curChamber); err != nil {
continue
}
inheritWith(curChamber, c)
@@ -90,6 +97,8 @@ func (s *InheritableStorage) Get(ctx context.Context, logicalPath string) (*Stor
func (s *InheritableStorage) Put(ctx context.Context, e StorageEntry) error {
logger := hclog.FromContext(ctx).ResetNamed("inheritable")
+ ctx, span := s.tracer.Start(ctx, "InheritableStorage Put", trace.WithAttributes(attribute.String("entry.key", e.Key)))
+ defer span.End()
logger.Debug("put operation", "logicalPath", e.Key)
if err := ValidatePath(e.Key); err != nil {
@@ -111,6 +120,8 @@ func (s *InheritableStorage) Put(ctx context.Context, e StorageEntry) error {
func (s *InheritableStorage) Delete(ctx context.Context, logicalPath string) error {
logger := hclog.FromContext(ctx).ResetNamed("inheritable")
+ ctx, span := s.tracer.Start(ctx, "InheritableStorage Delete", trace.WithAttributes(attribute.String("logicalPath", logicalPath)))
+ defer span.End()
logger.Debug("delete operation", "logicalPath", logicalPath)
if err := ValidatePath(logicalPath); err != nil {
@@ -132,6 +143,8 @@ func (s *InheritableStorage) Delete(ctx context.Context, logicalPath string) err
func (s *InheritableStorage) List(ctx context.Context, prefix string) ([]string, error) {
logger := hclog.FromContext(ctx).ResetNamed("inheritable")
+ ctx, span := s.tracer.Start(ctx, "InheritableStorage List", trace.WithAttributes(attribute.String("logicalPath", prefix)))
+ defer span.End()
logger.Debug("list operation", "prefix", prefix)
if err := ValidatePath(prefix); err != nil {
diff --git a/pkg/storage/storage.go b/pkg/storage/storage.go
index b24cee2..7dfdf18 100644
--- a/pkg/storage/storage.go
+++ b/pkg/storage/storage.go
@@ -2,13 +2,14 @@ package storage
import (
"context"
+ "encoding/json"
"errors"
"strings"
)
type StorageEntry struct {
Key string
- Value []byte
+ Value json.RawMessage
}
type Storage interface {
diff --git a/trace/otel.go b/trace/otel.go
new file mode 100644
index 0000000..13a2dc0
--- /dev/null
+++ b/trace/otel.go
@@ -0,0 +1,75 @@
+package trace
+
+import (
+ "context"
+ "time"
+
+ "go.opentelemetry.io/otel"
+ "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
+ "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
+ "go.opentelemetry.io/otel/propagation"
+ "go.opentelemetry.io/otel/sdk/resource"
+ "go.opentelemetry.io/otel/sdk/trace"
+ semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
+)
+
+func newHttpExporter(ctx context.Context) (trace.SpanExporter, error) {
+ return otlptracehttp.New(ctx, otlptracehttp.WithInsecure())
+}
+
+func newStdOutExporter() (trace.SpanExporter, error) {
+ return stdouttrace.New(
+ stdouttrace.WithPrettyPrint())
+}
+
+func SetupOtelInstrumentation(ctx context.Context, withStdOut bool) (func(ctx context.Context) error, error) {
+ var exp trace.SpanExporter
+ var err error
+ if withStdOut {
+ exp, err = newStdOutExporter()
+ } else {
+ exp, err = newHttpExporter(ctx)
+ }
+ if err != nil {
+ return nil, err
+ }
+
+ prop := newPropagator()
+ otel.SetTextMapPropagator(prop)
+
+ tp, err := newTraceProvider(exp)
+ if err != nil {
+ return nil, err
+ }
+
+ otel.SetTracerProvider(tp)
+ return tp.Shutdown, nil
+}
+
+func newPropagator() propagation.TextMapPropagator {
+ return propagation.NewCompositeTextMapPropagator(
+ propagation.TraceContext{},
+ propagation.Baggage{},
+ )
+}
+
+func newTraceProvider(traceExporter trace.SpanExporter) (*trace.TracerProvider, error) {
+ r, err := resource.Merge(
+ resource.Default(),
+ resource.NewWithAttributes(
+ semconv.SchemaURL,
+ semconv.ServiceName("realm"),
+ ),
+ )
+ if err != nil {
+ return nil, err
+ }
+
+ traceProvider := trace.NewTracerProvider(
+ trace.WithBatcher(traceExporter,
+ // Default is 5s. Set to 1s for demonstrative purposes.
+ trace.WithBatchTimeout(5*time.Second)),
+ trace.WithResource(r),
+ )
+ return traceProvider, nil
+}