Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-shape samples #89

Closed
discostu105 opened this issue Jun 4, 2019 · 5 comments
Closed

Re-shape samples #89

discostu105 opened this issue Jun 4, 2019 · 5 comments
Assignees
Labels
pkg:OpenTelemetry.Api Issues related to OpenTelemetry.Api NuGet package

Comments

@discostu105
Copy link
Member

Currently, there is just one project called "Samples", which contains examples of exporters. Then there is a solution folder called "testdata" with an ASP.Net Core project as example for how to use OpenTelemetry in ASP.NET Core.

What I am missing is an example of how to implement your own Tracer. I tried to add one, but then was not sure where to put it. "samples" vs. "testdata"? Should we combine them?

Suggestion:

  • Create a solution folder called "Samples"
  • Add samples, as separate projects for:
    • Exporter-implementations
    • ASP.NET Core sample
    • Tracer-Implementors (e.g. a simple logging-tracer), along with Sample-usage projects (e.g. simple console app, asp.net core app)
  • Each sample project should have a readme.md that explains what the sample project is supposed to show.

What do you think about that?

@discostu105
Copy link
Member Author

More specifically, I would just

  • move Samples project to samples\Exporters
  • move testdata\TestApp.AspNetCore.2.0 to samples\TestApp.AspNetCore.2.0
  • add samples\LoggingTracer\LoggingTracer
  • add samples\LoggingTracer\ConsoleApp
  • add samples\LoggingTracer\AspNetCore.2.0

@discostu105 discostu105 self-assigned this Jun 4, 2019
@SergeyKanzhelev
Copy link
Member

testdata\TestApp.AspNetCore.2.0 is used in tests. Do you want to make a copy instead?

@SergeyKanzhelev
Copy link
Member

one additional example - how library must be instrumented with an API.

@discostu105
Copy link
Member Author

You're right, testdata\TestApp.AspNetCore.2.0 is actually used in unit-tests, so I believe it is ok to keep it in testdata folder as it is for now.

@SergeyKanzhelev SergeyKanzhelev added the pkg:OpenTelemetry.Api Issues related to OpenTelemetry.Api NuGet package label Jun 11, 2019
@SergeyKanzhelev SergeyKanzhelev added this to the API complete milestone Jun 11, 2019
@discostu105
Copy link
Member Author

Closing this issue now. Sample folder has been created and LoggingTracer is on its way (#92).

Yun-Ting pushed a commit to Yun-Ting/opentelemetry-dotnet that referenced this issue Oct 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg:OpenTelemetry.Api Issues related to OpenTelemetry.Api NuGet package
Projects
None yet
Development

No branches or pull requests

2 participants