Skip to content

Commit

Permalink
Release v0.1.0-alpha (#76)
Browse files Browse the repository at this point in the history
* Add CHANGELOG

* Add versions.yaml

* Apply suggestions from code review

Co-authored-by: Robert Pająk <pellared@hotmail.com>

* Update update module names

* Update package import paths

* Prepare alpha for version v0.1.0-alpha

* Fix package path of offsets-tracker

* Apply suggestions from code review

Co-authored-by: Eden Federman <edenf2k@gmail.com>

* Update CHANGELOG.md

* Relative link

* Fix date

---------

Co-authored-by: Robert Pająk <pellared@hotmail.com>
Co-authored-by: Eden Federman <edenf2k@gmail.com>
  • Loading branch information
3 people committed Apr 17, 2023
1 parent 83cae24 commit f31f427
Show file tree
Hide file tree
Showing 33 changed files with 125 additions and 79 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Changelog

All notable changes to OpenTelemetry Go Automatic Instrumentation are documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

OpenTelemetry Go Automatic Instrumentation adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [v0.1.0-alpha] - 2023-04-17

This is the first release of OpenTelemetry Go Automatic Instrumentation.

[Unreleased]: https://github.com/open-telemetry/opentelemetry-go-instrumentation/compare/v0.1.0-alpha...HEAD
[v0.1.0-alpha]: https://github.com/open-telemetry/opentelemetry-go-instrumentation/releases/tag/v0.1.0-alpha
10 changes: 5 additions & 5 deletions cli/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ import (
"os/signal"
"syscall"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/errors"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/opentelemetry"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/process"
"go.opentelemetry.io/auto/pkg/errors"
"go.opentelemetry.io/auto/pkg/instrumentors"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/auto/pkg/opentelemetry"
"go.opentelemetry.io/auto/pkg/process"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion docs/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Notice that one of our design goals is to support stripped Go binaries - meaning

We currently track instrumented structs inside the Go standard library and selected open source packages. This solution does not require DWARF information on the target binary and provides stability to instrumentations. Instrumentation authors can get a field location by name instead of hard coding a field offset.

The offsets-tracker generates the [offset_results.json](https://github.com/open-telemetry/opentelemetry-go-instrumentation/blob/master/pkg/inject/offset_results.json) file. This file contains the offsets of the fields in the instrumented structs.
The offsets-tracker generates the [offset_results.json](https://github.com/open-telemetry/opentelemetry-go-instrumentation/blob/main/pkg/inject/offset_results.json) file. This file contains the offsets of the fields in the instrumented structs.

### Uretprobes

Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/open-telemetry/opentelemetry-go-instrumentation
module go.opentelemetry.io/auto

go 1.18

Expand Down
2 changes: 1 addition & 1 deletion internal/tools/go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/open-telemetry/opentelemetry-go-instrumentation/internal/tools
module go.opentelemetry.io/auto/internal/tools

go 1.18

Expand Down
2 changes: 1 addition & 1 deletion internal/tools/tools.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
//go:build tools
// +build tools

package tools // import "github.com/open-telemetry/opentelemetry-go-instrumentation/internal/tools"
package tools // import "go.opentelemetry.io/auto/internal/tools"

import (
_ "github.com/google/go-licenses"
Expand Down
4 changes: 2 additions & 2 deletions offsets-tracker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Fetching `go.dev` for discovering versions can be enabled by setting`.FindVersio
## Download Strategy

offsets-tracker wraps every Go module version as a Go application that depends on that module.
Those applications are the result of [generating template files](https://github.com/keyval-dev/offsets-tracker/tree/master/downloader/wrapper) with the appropriate version.
Those applications are the result of [generating template files](./downloader/wrapper) with the appropriate version.

In the case of the Go standard library, offsets-tracker downloads the published binary for the specified version.

Expand All @@ -85,7 +85,7 @@ VersionConstraint(&minimunGoVersion)
## Project Status

This project is currently in Alpha.
Check out our [issues section](https://github.com/keyval-dev/offsets-tracker/issues) to learn more about improvements we're working on.
Check out our [issues section](https://github.com/open-telemetry/opentelemetry-go-instrumentation/issues) to learn more about improvements we're working on.

## License

Expand Down
5 changes: 3 additions & 2 deletions offsets-tracker/cache/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ package cache
import (
"encoding/json"
"fmt"
"github.com/keyval-dev/offsets-tracker/binary"
"github.com/keyval-dev/offsets-tracker/schema"
"io/ioutil"
"log"
"os"

"go.opentelemetry.io/auto/offsets-tracker/binary"
"go.opentelemetry.io/auto/offsets-tracker/schema"
)

type Cache struct {
Expand Down
3 changes: 2 additions & 1 deletion offsets-tracker/downloader/go_wrapper.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ package downloader
import (
_ "embed"
"fmt"
"github.com/keyval-dev/offsets-tracker/utils"
"io/fs"
"io/ioutil"
"path"

"go.opentelemetry.io/auto/offsets-tracker/utils"
)

const appName = "testapp"
Expand Down
3 changes: 2 additions & 1 deletion offsets-tracker/downloader/remote_targz.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ package downloader

import (
"fmt"
"github.com/keyval-dev/offsets-tracker/utils"
"io"
"io/ioutil"
"net/http"
"os"
"path"

"go.opentelemetry.io/auto/offsets-tracker/utils"
)

const (
Expand Down
2 changes: 1 addition & 1 deletion offsets-tracker/go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/keyval-dev/offsets-tracker
module go.opentelemetry.io/auto/offsets-tracker

go 1.17

Expand Down
6 changes: 3 additions & 3 deletions offsets-tracker/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import (
"os"

"github.com/hashicorp/go-version"
"github.com/keyval-dev/offsets-tracker/binary"
"github.com/keyval-dev/offsets-tracker/target"
"github.com/keyval-dev/offsets-tracker/writer"
"go.opentelemetry.io/auto/offsets-tracker/binary"
"go.opentelemetry.io/auto/offsets-tracker/target"
"go.opentelemetry.io/auto/offsets-tracker/writer"
)

const (
Expand Down
11 changes: 6 additions & 5 deletions offsets-tracker/target/target.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ package target

import (
"fmt"
"github.com/hashicorp/go-version"
"github.com/keyval-dev/offsets-tracker/binary"
"github.com/keyval-dev/offsets-tracker/cache"
"github.com/keyval-dev/offsets-tracker/downloader"
"github.com/keyval-dev/offsets-tracker/versions"
"os"

"github.com/hashicorp/go-version"
"go.opentelemetry.io/auto/offsets-tracker/binary"
"go.opentelemetry.io/auto/offsets-tracker/cache"
"go.opentelemetry.io/auto/offsets-tracker/downloader"
"go.opentelemetry.io/auto/offsets-tracker/versions"
)

type VersionsStrategy int
Expand Down
3 changes: 2 additions & 1 deletion offsets-tracker/versions/go_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ package versions
import (
"encoding/json"
"fmt"
"github.com/keyval-dev/offsets-tracker/utils"

"go.opentelemetry.io/auto/offsets-tracker/utils"
)

type goListResponse struct {
Expand Down
4 changes: 2 additions & 2 deletions offsets-tracker/writer/writer.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import (
"sort"
"strings"

"github.com/keyval-dev/offsets-tracker/schema"
"github.com/keyval-dev/offsets-tracker/target"
"go.opentelemetry.io/auto/offsets-tracker/schema"
"go.opentelemetry.io/auto/offsets-tracker/target"
)

func WriteResults(fileName string, results ...*target.Result) error {
Expand Down
4 changes: 2 additions & 2 deletions pkg/inject/injector.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import (
"runtime"

"github.com/cilium/ebpf"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/process"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/auto/pkg/process"
)

var (
Expand Down
6 changes: 3 additions & 3 deletions pkg/instrumentors/allocator/allocator_linux.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ package allocator
import (
"os"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpffs"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/context"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"go.opentelemetry.io/auto/pkg/instrumentors/bpffs"
"go.opentelemetry.io/auto/pkg/instrumentors/context"
"go.opentelemetry.io/auto/pkg/log"
"golang.org/x/sys/unix"
)

Expand Down
4 changes: 2 additions & 2 deletions pkg/instrumentors/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
package instrumentors

import (
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/context"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/instrumentors/context"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
)

type Instrumentor interface {
Expand Down
10 changes: 5 additions & 5 deletions pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ import (
"errors"
"os"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpffs"
"go.opentelemetry.io/auto/pkg/instrumentors/bpffs"

"github.com/cilium/ebpf"
"github.com/cilium/ebpf/link"
"github.com/cilium/ebpf/perf"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/inject"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/context"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"go.opentelemetry.io/auto/pkg/inject"
"go.opentelemetry.io/auto/pkg/instrumentors/context"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/otel/attribute"
semconv "go.opentelemetry.io/otel/semconv/v1.7.0"
"go.opentelemetry.io/otel/trace"
Expand Down
10 changes: 5 additions & 5 deletions pkg/instrumentors/bpf/google/golang/org/grpc/probe.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ import (
"strings"

"github.com/cilium/ebpf"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpffs"
"go.opentelemetry.io/auto/pkg/instrumentors/bpffs"

"github.com/cilium/ebpf/link"
"github.com/cilium/ebpf/perf"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/inject"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/context"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"go.opentelemetry.io/auto/pkg/inject"
"go.opentelemetry.io/auto/pkg/instrumentors/context"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/otel/attribute"
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
"go.opentelemetry.io/otel/trace"
Expand Down
10 changes: 5 additions & 5 deletions pkg/instrumentors/bpf/google/golang/org/grpc/server/probe.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ import (
"errors"
"os"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpffs"
"go.opentelemetry.io/auto/pkg/instrumentors/bpffs"

"github.com/cilium/ebpf"
"github.com/cilium/ebpf/link"
"github.com/cilium/ebpf/perf"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/inject"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/context"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"go.opentelemetry.io/auto/pkg/inject"
"go.opentelemetry.io/auto/pkg/instrumentors/context"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/otel/attribute"
semconv "go.opentelemetry.io/otel/semconv/v1.7.0"
"go.opentelemetry.io/otel/trace"
Expand Down
10 changes: 5 additions & 5 deletions pkg/instrumentors/bpf/net/http/server/probe.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ import (
"errors"
"os"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpffs"
"go.opentelemetry.io/auto/pkg/instrumentors/bpffs"

"github.com/cilium/ebpf"
"github.com/cilium/ebpf/link"
"github.com/cilium/ebpf/perf"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/inject"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/context"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"go.opentelemetry.io/auto/pkg/inject"
"go.opentelemetry.io/auto/pkg/instrumentors/context"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/otel/attribute"
semconv "go.opentelemetry.io/otel/semconv/v1.7.0"
"go.opentelemetry.io/otel/trace"
Expand Down
4 changes: 2 additions & 2 deletions pkg/instrumentors/context/inst_context.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ package context

import (
"github.com/cilium/ebpf/link"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/inject"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/process"
"go.opentelemetry.io/auto/pkg/inject"
"go.opentelemetry.io/auto/pkg/process"
)

type InstrumentorContext struct {
Expand Down
18 changes: 9 additions & 9 deletions pkg/instrumentors/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ package instrumentors
import (
"fmt"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/allocator"
gorillaMux "github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpf/github.com/gorilla/mux"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpf/google/golang/org/grpc"
grpcServer "github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpf/google/golang/org/grpc/server"
httpServer "github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/bpf/net/http/server"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/opentelemetry"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/process"
"go.opentelemetry.io/auto/pkg/instrumentors/allocator"
gorillaMux "go.opentelemetry.io/auto/pkg/instrumentors/bpf/github.com/gorilla/mux"
"go.opentelemetry.io/auto/pkg/instrumentors/bpf/google/golang/org/grpc"
grpcServer "go.opentelemetry.io/auto/pkg/instrumentors/bpf/google/golang/org/grpc/server"
httpServer "go.opentelemetry.io/auto/pkg/instrumentors/bpf/net/http/server"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/auto/pkg/opentelemetry"
"go.opentelemetry.io/auto/pkg/process"
)

type instrumentorsManager struct {
Expand Down
8 changes: 4 additions & 4 deletions pkg/instrumentors/runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ import (

"github.com/cilium/ebpf/link"
"github.com/cilium/ebpf/rlimit"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/inject"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/context"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/process"
"go.opentelemetry.io/auto/pkg/inject"
"go.opentelemetry.io/auto/pkg/instrumentors/context"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/auto/pkg/process"
)

func (m *instrumentorsManager) Run(target *process.TargetDetails) error {
Expand Down
4 changes: 2 additions & 2 deletions pkg/opentelemetry/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (
"runtime"
"time"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"github.com/prometheus/procfs"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
"go.opentelemetry.io/otel/sdk/resource"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
Expand Down
2 changes: 1 addition & 1 deletion pkg/opentelemetry/id_generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ package opentelemetry
import (
"context"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/instrumentors/events"
"go.opentelemetry.io/auto/pkg/instrumentors/events"
"go.opentelemetry.io/otel/trace"
)

Expand Down
4 changes: 2 additions & 2 deletions pkg/process/analyze.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"strings"

"github.com/hashicorp/go-version"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/process/ptrace"
"go.opentelemetry.io/auto/pkg/log"
"go.opentelemetry.io/auto/pkg/process/ptrace"
"golang.org/x/arch/x86/x86asm"
)

Expand Down
4 changes: 2 additions & 2 deletions pkg/process/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"strings"
"time"

"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/errors"
"github.com/open-telemetry/opentelemetry-go-instrumentation/pkg/log"
"go.opentelemetry.io/auto/pkg/errors"
"go.opentelemetry.io/auto/pkg/log"
)

type processAnalyzer struct {
Expand Down
Loading

0 comments on commit f31f427

Please sign in to comment.