LocalForwarderChannel (#723)

* added proto files to src folder. added protobuf codegen plugin to build

* set package for protobuf java files

* removed unneeded files; excluded *.proto from jar

* removed c# related file

* removed some extra spaces

* first pass at refactoring for channel implementation

* javadoc for type param; updated tests

* finished pull up of common methods to ATelemetryChannel.
updated build so IntelliJ can see generated code.
removed method overload from interface (bad practice...)
implemented simple LocalForwarderTelemetryTransmitter and Factory (doesn't have the retry logic like the InProcess Factory)

* ignore generated files.
updated build file to shadow services provided with grpc libraries.

* Surfaces type and envelope names for classes;
Also surfaces BaseData version number.
Deprecated *Telemetry classes who's *Data classes were also deprecated.
Some additional fields were surfaced which were previously hidden.

* if using localforwarder, force sdk quickpulse to be disabled.
Fixed some bug with QuickPulse grabbing CPU data before the first datum is initialized; i.e. skip if null.
Changed logic so a Nop channel is used if a custom channel is misconfigured and cannot be initialized.

* fixed case for key to be consistent with other SDKs

* added cleanup code to make thread shutdown more reliable.

* implemented channel with transformation functions from internal model to proto model.

* recognize if the given name is the default channel.

* Instead of disabling telemetry, just log a warning about channel configuration. This should still work if the channel is set after configuration.
Use singleton for nop channel and don't actually set channel in TelemetryConfiguration, just return NopTelemetryChannel instance.
Updated test to check for nop channel instead of null.

* set stddev to 0.0 in this helper method

* stubbed in test classes.
exposed some methods for testing

* added tests for transformation functions.

* use %n instead of \n in format string

* extracted the exception transformer functions for stackframe and exceptiondetails to be visiblefortesting
corrected one precondition which was casing issues.

* wrote tests for the utility functions in the localforwarder transformer functions

* extracted transmitter into its own class.
wrote test for transmitter.

* added assert to fail if timeout is reached

* wrote tests for localforwarderchanel.
exposed some methods for inserting mocks.
removed final from some classes so they could be mocked.

* added grpc-test to build and created proper transmitter test.
reworked parameters in transmitter constructor to be more easily testable.
removed endpoint field since it's not necessary to keep around.

* renamed abstract class to fit project conventions

* added javadoc

* using private lock object instead

* we should throw if it fails to configure

* ENVELOPE_NAME can be private

* MetricTelemetry.ENVELOPE_NAME cannot be private, though...

* fix spacing

* we only need 1 thread minimum

* remove redundant null check

* fixed typo

* Revert "ENVELOPE_NAME can be private"

This reverts commit 0fb0898.

* removed unused import

* added isInitialized to prevent calling initialize twice

* removed additional field in Envelope since it's generated.

* removed unused import.

* fixed tests after refactor

* remove enableRetry from ManagedChannel; we don't want to use experimental API

* removed commented code in build script

* updated TPN

* reworked shutdown to be aysnc. added retry to grpcchannel

* removed sync

* updated changelog

* added null check for test scenario

Author: littleaj

CHANGELOG.md

@@ -13,6 +13,7 @@ Introduced `CloudContext` to hold replacements, `getRole`/`setRole` and `getRole
 `DeviceInfoContextInitializer` will continue to send the deprecated field in `DeviceContext`.
 This will be removed in a future release.
 Users should use begin using the `CloudInfoContextInitializer` to continue to receive the proper value for `cloud_roleInstance` in telemetry items.
+- Adds `LocalForwarderChannel` for use with the LocalForwarder.
 
 # Version 2.1.2
 - Fix [#676](https://github.com/Microsoft/ApplicationInsights-Java/issues/676). This fixes the HTTP dependency collection when using NetFlix Zuul Library.

ThirdPartyNotices.txt

@@ -18,6 +18,10 @@ Microsoft Application Insights Java Software Development Kit consists of materia
 10.	Guava version 12.0.1 (http://code.google.com/p/guava-libraries/)
 11.	INFOMAS PCM Application Suite version 3.0.4 (https://github.com/rmuller/infomas-asl)
 12.	JSR-305 version 2.0.1 (http://code.google.com/p/jsr-305/)
+13. Protobuf-java version 3.6.1 (https://github.com/protocolbuffers/protobuf)
+14. gRPC Stubs version 1.14.0 (https://github.com/grpc/grpc-java)
+15. gRPC Protobuf version 1.14.0 (https://github.com/grpc/grpc-java)
+16. gRPC Netty-shaded version 1.14.0 (https://github.com/grpc/grpc-java)
 
 %% Apache Commons-codec NOTICES, INFORMATION, AND LICENSE BEGIN HERE
 =========================================
@@ -862,4 +866,216 @@ Code generated by the Protocol Buffer compiler is owned by the owner
 of the input file used when generating it.  This code is not
 standalone and requires a support library to be linked with it.  This
 support library is itself covered by the above license.
-=========================================
+=========================================
+
+
+=========================================
+gRPC Stubs, 
+gRPC Protobuf, 
+gRPC Netty-shaded
+
+Copyright 2014 The gRPC Authors
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   
+   

azure-application-insights-spring-boot-starter/src/main/java/com/microsoft/applicationinsights/autoconfigure/ApplicationInsightsProperties.java

@@ -22,6 +22,7 @@
 package com.microsoft.applicationinsights.autoconfigure;
 
 import com.microsoft.applicationinsights.autoconfigure.helpers.IkeyResolver;
+import com.microsoft.applicationinsights.channel.concrete.TelemetryChannelBase;
 import com.microsoft.applicationinsights.channel.concrete.inprocess.InProcessTelemetryChannel;
 import com.microsoft.applicationinsights.internal.channel.common.TransmissionFileSystemOutput;
 import com.microsoft.applicationinsights.internal.channel.common.TransmissionNetworkOutput;
@@ -199,10 +200,10 @@ static class InProcess {
        * 1000.
        */
       private int maxTelemetryBufferCapacity =
-          InProcessTelemetryChannel.DEFAULT_MAX_TELEMETRY_BUFFER_CAPACITY;
+          TelemetryChannelBase.DEFAULT_MAX_TELEMETRY_BUFFER_CAPACITY;
       /** Interval to send telemetry. Must be between 1 and 300. */
       private int flushIntervalInSeconds =
-          InProcessTelemetryChannel.DEFAULT_FLUSH_BUFFER_TIMEOUT_IN_SECONDS;
+          TelemetryChannelBase.DEFAULT_FLUSH_BUFFER_TIMEOUT_IN_SECONDS;
       /**
        * Size of disk space that Application Insights can use to store telemetry in case of network
        * outage. Must be between 1 and 1000.
@@ -213,7 +214,7 @@ static class InProcess {
       private boolean throttling = true;
 
       /** Sets the size of maximum instant retries without delay */
-      private int maxInstantRetry = InProcessTelemetryChannel.DEFAULT_MAX_INSTANT_RETRY;
+      private int maxInstantRetry = TelemetryChannelBase.DEFAULT_MAX_INSTANT_RETRY;
 
       public boolean isDeveloperMode() {
         return developerMode;

core/.gitignore

@@ -0,0 +1 @@
+src/main/generated

core/build.gradle

@@ -35,6 +35,21 @@ apply from: "$buildScriptsDir/common-java.gradle"
 apply from: "$buildScriptsDir/publishing.gradle"
 
 apply plugin: 'com.google.protobuf'
+apply plugin: 'idea'
+
+def sdkVersionFileDir = "$project.buildDir/src/generated/main/resources"
+
+def generatedDir = 'generated'
+def generatedPath = "src/main/$generatedDir"
+
+idea {
+    module {
+        generatedSourceDirs = [ file(generatedPath) ]
+
+        sourceDirs += file('src/main/java')
+        sourceDirs += file(generatedPath)
+    }
+}
 
 protobuf {
     protoc {
@@ -48,13 +63,34 @@ protobuf {
     generateProtoTasks {
         all().each { task ->
             task.builtins {
-                java { }
+                java {
+                    outputSubDir = generatedDir
+                }
             }
             task.plugins {
-                grpc { }
+                grpc {
+                    outputSubDir = generatedDir
+                }
             }
         }
     }
+    generatedFilesBaseDir = "${projectDir}/src/"
+}
+
+sourceSets {
+    main {
+        output.dir(generatedPath, builtBy: 'generateProto')
+        java {
+            srcDirs generatedPath
+        }
+        resources {
+            srcDir sdkVersionFileDir
+        }
+    }
+}
+
+clean {
+    delete 'src/main/generated'
 }
 
 import org.apache.tools.ant.taskdefs.condition.Os
@@ -89,15 +125,18 @@ dependencies {
     compile ([group: 'com.google.protobuf', name:'protobuf-java', version:'3.6.1'])
     compile ([group: 'io.grpc', name: 'grpc-stub', version: '1.14.0'])
     compile ([group: 'io.grpc', name: 'grpc-protobuf', version: '1.14.0'])
+    runtime ([group: 'io.grpc', name: 'grpc-netty-shaded', version: '1.14.0'])
     testCompile group:'org.hamcrest', name:'hamcrest-library', version:'1.3'
     testCompile group: 'junit', name: 'junit', version: '4.12'
     testCompile group: 'org.mockito', name: 'mockito-core', version: '1.10.19'
     testCompile group: 'com.google.code.gson', name: 'gson', version: '2.8.2'
+    testCompile group: 'io.grpc', name:'grpc-testing', version:'1.14.0'
 }
 
 ext.dependenciesPrefix = 'com.microsoft.applicationinsights.core.dependencies'
 shadowJar {
     classifier=''
+    mergeServiceFiles()
     relocate 'org.apache.http', "${dependenciesPrefix}.http"
     relocate 'eu.infomas.annotation', "${dependenciesPrefix}.annotation"
     relocate 'org.apache.commons', "${dependenciesPrefix}.apachecommons"
@@ -114,22 +153,13 @@ jar {
     enabled = false
 }
 
-def sdkVersionFileDir = "$project.buildDir/src/generated/main/resources"
 task generateVersionProperties(type: PropsFileGen) {
     targetFile = new File(sdkVersionFileDir, "sdk-version.properties")
     property "version", project.version
 }
 
 processResources.dependsOn generateVersionProperties
 
-sourceSets {
-    main {
-        resources {
-            srcDir sdkVersionFileDir
-        }
-    }
-}
-
 // region Publishing properties
 
 projectPomName = project.msftAppInsights + " Java SDK Core"

core/src/main/java/com/microsoft/applicationinsights/TelemetryClient.java

@@ -516,7 +516,7 @@ public void flush() {
      * Gets the channel used by the client.
      */
     TelemetryChannel getChannel() {
-        if (channel == null) {
+        if (this.channel == null) {
             this.channel = configuration.getChannel();
         }