Skip to content

Third party, Notice and updated Readme #5

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 13, 2020
Merged

Third party, Notice and updated Readme #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d460b8
Third party, Notice and updated Readme
lupengamzn Jul 10, 2020
5b524e1
Updated Readme and Notice
lupengamzn Jul 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copy link
Contributor

@anuraaga anuraaga Jul 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you remove this file? It's not an open source license so doesn't belong here. We already have the open source license in LICENSE so don't need this file.

Copy link
Contributor

@anuraaga anuraaga Jul 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI aws/aws-xray-sdk-dotnet#139

Copy link
Contributor Author

@lupengamzn lupengamzn Jul 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's removed

Copy link
Contributor

@willarmiros willarmiros Jul 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe since NOTICE is auto-committed by Amazon open source, we should inquire with them before removing this file.

Copy link
Contributor Author

@lupengamzn lupengamzn Jul 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this line AWS X-Ray SDK .NET Agent to the NOTICE, so I guess it's can be removed.

40 changes: 17 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,24 +54,24 @@ Note:

## Installation

The AWS X-Ray Auto-Instrumentation SDK for .NET (.netframework 4.5 and above) and .NET Core (.netstandard 2.0 and above) is in the form of Nuget package. You can install the package from [Nuget](https://www.nuget.org/) gallery or from Visual Studio editor. Search `AWSXRayRecorder.AutoInstrumentation`.
### Minimum Requirements

### Automatic Instrumentation
For building `AWSXRayRecorder.AutoInstrumentation` package, you need to install **Visual Studio 2019**.

#### Internet Information Services (IIS)
For building profiler, you need to have workloads **.NET desktop development** and **Desktop development with C++** installed within **Visual Studio 2019**.

##### Asp.Net Core
### Development

1. Import `AWSXRayRecorder.AutoInstrumentation` Nuget package into your project and **rebuild**.
2. Download and run AWS X-Ray .NET Agent Installer.
3. Restart IIS and launch your application.
```
iisreset
```
Currently, the `AWSXRayRecorder.AutoInstrumentation` Nuget hasn’t been released yet (please stay tuned!), so in case that you need to add it to you application, you can git clone this repo, reference `AWSXRayRecorder.AutoInstrumentation` package to your application and rebuild.

##### Asp.Net
### Automatic Instrumentation

#### Internet Information Services (IIS)

##### Asp.Net Core & Asp.Net

1. Download and run AWS X-Ray .NET Agent Installer.
1. Import `AWSXRayRecorder.AutoInstrumentation` package into your project and **rebuild**.
2. Download and run AWS X-Ray .NET Agent Installer ([x64](https://s3.console.aws.amazon.com/s3/buckets/aws-xray-assets.us-east-2/xray-agent-installer/aws-xray-dotnet-agent-installer-beta-X64.msi) and [x86](https://s3.console.aws.amazon.com/s3/buckets/aws-xray-assets.us-east-2/xray-agent-installer/aws-xray-dotnet-agent-installer-beta-X86.msi)).
3. Restart IIS and launch your application.
```
iisreset
Expand All @@ -81,8 +81,8 @@ iisreset

##### Asp.Net Core

1. Import `AWSXRayRecorder.AutoInstrumentation` Nuget package into your project and **rebuild**.
2. Download and install AWS X-Ray .NET Agent Installer.
1. Import `AWSXRayRecorder.AutoInstrumentation` package into your project and **rebuild**.
2. Download and install AWS X-Ray .NET Agent Installer ([x64](https://s3.console.aws.amazon.com/s3/buckets/aws-xray-assets.us-east-2/xray-agent-installer/aws-xray-dotnet-agent-installer-beta-X64.msi) and [x86](https://s3.console.aws.amazon.com/s3/buckets/aws-xray-assets.us-east-2/xray-agent-installer/aws-xray-dotnet-agent-installer-beta-X86.msi)).
3. Launch your application as follows.
```
SET CORECLR_PROFILER = {AE47A175-390A-4F13-84CB-7169CEBF064A}
Expand All @@ -96,7 +96,7 @@ Note:

##### Asp.Net

1. Import `AWSXRayRecorder.AutoInstrumentation` Nuget package into your project and **rebuild**.
1. Import `AWSXRayRecorder.AutoInstrumentation` package into your project and **rebuild**.
2. Add the following snippet into the `web.config` file.
```
<system.webServer>
Expand All @@ -113,19 +113,13 @@ Note:

Instead of using profiler, you may choose to manually instrument AWS X-Ray SDK into your Asp.Net Core application.

1. Import `AWSXRayRecorder.AutoInstrumentation` Nuget package into your project.
1. Import `AWSXRayRecorder.AutoInstrumentation` package into your project.

2. Add the following method into any method in `startup.cs` or `program.cs` file
```
Amazon.XRay.Recorder.AutoInstrumentation.Initialize.AddXRay();
```

## Development

### Minimum Requirements

For building packages locally, you need to have Visual Studio 2019 installed with workloads **.NET desktop development** and **Desktop development with C++**.

## Getting Help

Please use these community resources for getting help.
Expand All @@ -141,4 +135,4 @@ The [developer guide](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-

## License

The AWS X-Ray SDK DotNet Agent is licensed under the Apache 2.0 License. See LICENSE and NOTICE.txt for more information.
The AWS X-Ray SDK DotNet Agent is licensed under the Apache 2.0 License. See LICENSE for more information.
Loading