1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-12 10:04:29 +02:00
Commit Graph

38 Commits

Author SHA1 Message Date
Andrew Hsu
27aa1f6011
update go documentation badge image (#1322)
Signed-off-by: Andrew Hsu <xuzuan@gmail.com>

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2020-11-12 07:33:04 -08:00
Tyler Yahn
034195692a
Update README and documentation to better communicate pre-GA state (#1281)
* Update README

Move project status to top of project documentation and add explicit
warnings that this project may introduce breaking changes.

* Add disclaimer to public packages docs

* Use explicit warning in README
2020-10-29 09:23:13 -07:00
Tyler Yahn
8ed55f5980
Update README with Org GA project board (#1253) 2020-10-13 15:02:38 -07:00
Tyler Yahn
06a0be789a
Update README.md (#1106)
* Update README.md

Replace `Installation` and `Compatible Libraries` sections with a more
comprehensive `Getting Started` section to address the two actions most
users will want to know about: instrumenting and exporting.

Remove the code example.

Add links to project boards and milestones to address project status
questions.

* Fix spelling error

* Apply suggestions from code review

Co-authored-by: ET <evantorrie@users.noreply.github.com>

Co-authored-by: ET <evantorrie@users.noreply.github.com>
2020-08-27 12:14:37 -07:00
Poga Po
0ba595bddb
fix broken example link by directly link to the example directory (#1071)
* fix broken example link to the example directory

* Update README.md

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2020-08-19 19:57:03 -07:00
Tyler Yahn
2dfa5e4fe1
Remove WithSpan method from Tracer interface (#1043)
* Remove WithSpan method from Tracer interface

Also remove implementation in SDK.

* Add panic event reporting to span End

* Update Changelog with changes

* Update CHANGELOG.md

* Update README.md

Fix code tabs

* Refactor span End

* Fix un-ended span from feedback.
2020-08-08 12:10:36 -07:00
Bogdan Drutu
5616fc55fc
Remove unnecessary schedule from readme (#997)
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2020-07-30 10:36:26 -07:00
Brandon Philips
7918070617
README: fixup spaces on code example (#961)
The code example was rendering oddly in github.com because the first
line had 4 spaces instead of tabs like the rest of the example. Fix
this.
2020-07-23 09:08:26 -07:00
Tyler Yahn
452256cbf4
Unify trace and metric stdout exporters (#956)
* Consolidate stdout exporter

* Move config to own file and match project standard

* Abstract Exporter into unified struct

* Rename trace part of the exporter

* Update import paths and configuration

* Update tests

* Update InstallNewPipeline to not return traceProvider

It is a registered global, access it that way.

* Update example_test

* Update docs

* Update example to be for whole package

* Update metric output

Closer match the span output.

* Clean up span output

Print as a batch and cleanup marshaling.

* Correct spelling error in doc

* Add Exporters README

* Update Changelog

* Propagate changes to rest of project

* Lint fixes

* Fix example test in metric SDK

* Add disable config options for trace and metric

Co-authored-by: Liz Fong-Jones <lizf@honeycomb.io>
2020-07-22 12:34:44 -07:00
Andrew Hsu
0f771bba67
added readme section to point to contrib repo (#612)
Signed-off-by: Andrew Hsu <xuzuan@gmail.com>
2020-04-02 10:58:09 -07:00
Rahul Patel
57d5f55600
Prepare for releasing v0.4.0 (#603)
* Prepare for releasing v0.4.0

* update README.

* remove target date for released features.
2020-03-30 14:33:27 -07:00
Andrew Hsu
5d346a4190
update godoc.org links to pkg.go.dev (#602)
Banner at the top of godoc.org pages are already asking users to
redirect to pkg.go.dev as mentioned in blog post
https://blog.golang.org/pkg.go.dev-2020

Signed-off-by: Andrew Hsu <xuzuan@gmail.com>
2020-03-30 15:40:38 -04:00
Mike Goldsmith
2ccddfe82a
Update README with import instructions and how to build / test (#505)
* update README with import instructions and how to build / test

* fix typo

* remove building the code section from README.md

* add clone instructions to CONTRIBUTING.md

Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
Co-authored-by: Rahul Patel <rahulpa@google.com>
2020-03-12 09:52:12 -07:00
Gustavo Silva Paiva
85751428a3
add shorter version for global providers (#538) 2020-03-11 08:23:32 -07:00
Tyler Yahn
52fb033e13
Rename the exporter directory to exporters (#502)
The `go.opentelemetry.io/otel/exporter/trace/jaeger` package was
mistakenly released with a `v1.0.0` tag instead of `v0.1.0`. This
resulted in all subsequent releases not becoming the default latest,
meaning that `go get`s pulled in the incompatible `v0.1.0` release of
that package when pulling in more recent packages from other otel
packages. Renaming the `exporter` directory to `exporters` fixes this
issue by consequentially renaming the package.

Additionally, this action also renames *all* exporters. This is
understood to be a disruptive action to existing users as they will need
to update any dependencies they currently have on our exporters.
However, it was decided to take this action regardless. The need to
resolve the existing issue explained above is highly important, and
given the Alpha state of this project these kinds of breaking changes
should be expected (though not without reason).

Resolves #331

Co-authored-by: Rahul Patel <rghetia@yahoo.com>
2020-03-02 13:54:57 -08:00
Liz Fong-Jones
501cd75de6
Document compatible exporters in a neutral fashion (#405) 2019-12-31 13:48:24 -05:00
rghetia
658dd7d1b9
update release schedule. (#378)
- fixes #367
2019-12-09 15:31:25 -08:00
Dan Miller
30795ef58c readme: fix quick start example (#374)
Fixes #257, #305
2019-12-07 09:26:41 +11:00
ferhat elmas
1bf93b3d23 Put direct link for doc and use https (#368) 2019-12-04 09:39:55 +11:00
Cheng-Lung Sung
13cd2ac417 move /global to /api/global (#356)
implement #337
2019-11-25 20:41:24 -08:00
ferhat elmas
90ba74e15a Fix url to website in readme (#323) 2019-11-15 15:22:17 -08:00
Liz Fong-Jones
2ac5725bc3 update README for v0.1.0 (#291) 2019-11-05 05:49:02 -08:00
rghetia
15bfc5bb12
Namespace import path under "/otel" (#274)
Also fixes example module paths so that they use the vanity URL instead
of the github URL.

[Closes #184]
2019-11-01 11:40:29 -07:00
Gustavo Silva Paiva
a71ec85f5e add gitter icon to readme (#269) 2019-10-31 21:56:25 -07:00
Krzesimir Nowak
3ac3846357 minor fixes in readme (#244) 2019-10-28 12:46:52 -07:00
Joshua MacDonald
0025ffcc71
Remove the experimental SDK (#221)
* Remove the experimental SDK

* Remove the experimental SDK from README.md

* Remove the experimental SDK from Makefile
2019-10-17 14:21:50 -07:00
rghetia
e0eccc9a57
update the schedule. (#204) 2019-10-14 14:42:01 -07:00
rghetia
7797bf9837
update README.md with quick start and release date. (#157) 2019-10-01 22:43:06 -07:00
Krzesimir Nowak
a936b8fb00 Add some docs about useful step before filing a PR (#151)
* Add a document about contributing

It is shamelessly stolen from opentelemetry-python and edited to be
relevant to opentelemetry-go. This file should explain some less
obvious things about the development of the project, like running
linters and regenerating the files.

* Force the use of go modules

Until go 1.13 modules were disabled by default if the repository was
inside GOPATH. This was causing issues when running `make precommit`
for the first time, as it could not find sources for any of the tools
used in `make precommit` under `${GOPATH}/src`. With setting the
`GO111MODULE` environment variable to `on`, we tell `go` to behave
differently, just like go 1.13 does by default.
2019-10-01 09:16:45 -07:00
Joshua MacDonald
a3ae50d8bc
Remove experimental/streaming globals, add streaming example (#135)
* Remove globals from exp/streaming

* basic example

* Build the streaming example

* Update README.md for running streaming example

* Remove observer package

* Move observer to exporter

* Fix

* Re-run make circle-ci
2019-09-23 14:39:10 -07:00
Koichi Shiraishi
27bb6c8c7f Fix godoc and goreportcard badge url to use vanity import path (#108) 2019-08-26 09:11:07 -07:00
Krzesimir Nowak
6c2b769f8c Update some paths in README.md (#88)
Some code got moved, so reflect that in the README.
2019-08-12 15:46:56 -07:00
Edward Muller
99906da7a6 Misc Makefile and README.md updates (#78)
Enabling misspell and goimports in golangci-lint allows a bit of
simplification of tools.go / Makefile.

The linters enabled locally also complained about the markdown in
README.md a little, so I fixed those complaints.

I also enabled auto-fix mode in golangci-lint so that it will just
fix any lint issues it runs across (which is how goimports/misspell)
was being used.

misspell still needs to be included in tools.go unless we decide that
we didn't want it to run on markdown files.
2019-08-05 13:58:24 -07:00
rghetia
ed3b26b6c8
add misspell tool fix common spelling mistakes. (#69) 2019-08-02 10:44:32 -07:00
thinkerou
2c77e484b4 add lint icon (#58) 2019-07-16 21:52:48 -07:00
thinkerou
50f16dd16b add circle-ci svg icon to readme (#45) 2019-07-03 07:43:54 -07:00
Isobel Redelmeier
c9df470779 Add Godoc link to README (#44)
[Closes #43]
2019-07-02 16:22:54 -07:00
Joshua MacDonald
e17f4468a6 Golang opentelemetry-go draft API (incomplete) (#9)
* Work in progress from https://github.com/lightstep/opentelemetry-golang-prototype

* Renames

* Rename

* Finish rename

* Rename packages

* README
2019-06-14 11:37:05 -07:00