Skip to content

Commit

Permalink
applying review remarks open-telemetry#2
Browse files Browse the repository at this point in the history
  • Loading branch information
pdelewski committed Dec 19, 2023
1 parent c4c305f commit 08c063a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions instrgen/docs/design.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenTelemetry Go Source Automatic Instrumentation - design

This document describes design of `instrgen` - compile time automatic OpenTelemetry instrumentation for GO programming language.
This document describes design of `instrgen` - compile time automatic OpenTelemetry instrumentation for Go programming language.

## Background

Expand All @@ -11,7 +11,7 @@ Language and its internals influence instrumentation techniques.
In dynamic languages it's very easy to replace original implementation. This is done by providing a new
implementation built on top of the original one. A technique called monkey patching (i.e. Python decorators).

GO is statically typed, natively compiled programming language which means that works on bare methal without
Go is statically typed, natively compiled programming language which means that works on bare methal without
virtual machine in between. The only component that lives between your program and machine is operating system.
Because of this limitation, auto-instrumentation of Go programs is limited to the following:

Expand All @@ -26,7 +26,7 @@ Compile time instrumentation is not different by other mechanisms described abov
The fundamental difference is the injection point, instrumentation has to be done
at compile time which has cons and pros.

GO is perfect language for compile time instrumentation for two main reasons:
Go is perfect language for compile time instrumentation for two main reasons:
- everything that's needed is in standard library
- it's easy to control compilation process due to go compiler architecture

Expand Down

0 comments on commit 08c063a

Please sign in to comment.