feat: Add telemetry to espressif-ide #1082
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,26 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| /******************************************************************************* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * Copyright 2024 Espressif Systems (Shanghai) PTE LTD. All rights reserved. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * Use is subject to license terms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| *******************************************************************************/ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| package com.espressif.idf.core.logging; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import java.util.Map; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import com.microsoft.applicationinsights.TelemetryClient; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * Azure Telemetry logger | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * @author Kondal Kolipaka <[email protected]> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| public class TelemetryLogger | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| private static final TelemetryClient telemetryClient = new TelemetryClient(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| public static void logEvent(String eventName, Map<String, String> properties) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| telemetryClient.trackEvent(eventName, properties, null); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| telemetryClient.flush(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+19
to
+24
There was a problem hiding this comment. The TelemetryClient is created without any configuration or error handling. Consider adding initialization logic to handle cases where telemetry might not be available or configured properly.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <classpath> | ||
| <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"> | ||
| <attributes> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> | ||
| <classpathentry kind="src" output="bin" path="src"> | ||
| <attributes> | ||
| <attribute name="optional" value="true"/> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER"> | ||
| <attributes> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry kind="output" path="bin"/> | ||
| </classpath> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /target/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <projectDescription> | ||
| <name>com.espressif.idf.telemetry</name> | ||
| <comment></comment> | ||
| <projects> | ||
| </projects> | ||
| <buildSpec> | ||
| <buildCommand> | ||
| <name>org.eclipse.jdt.core.javabuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.pde.ManifestBuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.pde.SchemaBuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.m2e.core.maven2Builder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| </buildSpec> | ||
| <natures> | ||
| <nature>org.eclipse.m2e.core.maven2Nature</nature> | ||
| <nature>org.eclipse.pde.PluginNature</nature> | ||
| <nature>org.eclipse.jdt.core.javanature</nature> | ||
| </natures> | ||
| </projectDescription> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| eclipse.preferences.version=1 | ||
| encoding/<project>=UTF-8 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| eclipse.preferences.version=1 | ||
| org.eclipse.jdt.core.compiler.codegen.targetPlatform=21 | ||
| org.eclipse.jdt.core.compiler.compliance=21 | ||
| org.eclipse.jdt.core.compiler.problem.assertIdentifier=error | ||
| org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled | ||
| org.eclipse.jdt.core.compiler.problem.enumIdentifier=error | ||
| org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning | ||
| org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning | ||
| org.eclipse.jdt.core.compiler.release=enabled | ||
| org.eclipse.jdt.core.compiler.source=21 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| activeProfiles= | ||
| eclipse.preferences.version=1 | ||
| resolveWorkspaceProjects=true | ||
| version=1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| Manifest-Version: 1.0 | ||
| Bundle-ManifestVersion: 2 | ||
| Bundle-Name: Telemetry | ||
| Bundle-SymbolicName: com.espressif.idf.telemetry | ||
| Bundle-Version: 1.0.0.qualifier | ||
| Eclipse-BundleShape: dir | ||
| Bundle-Vendor: Espressif Systems | ||
| Automatic-Module-Name: com.espressif.idf.telemetry | ||
| Bundle-RequiredExecutionEnvironment: JavaSE-17 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| source.. = src/ | ||
| output.. = bin/ | ||
| bin.includes = META-INF/,\ | ||
| .,\ | ||
| rootfiles/ | ||
| root=rootfiles | ||
| root.files=rootfiles/** |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <artifactId>com.espressif.idf.telemetry</artifactId> | ||
| <version>1.0.0-SNAPSHOT</version> | ||
| <packaging>eclipse-plugin</packaging> | ||
|
|
||
| <parent> | ||
| <groupId>com.espressif.idf</groupId> | ||
| <artifactId>com.espressif.idf.bundles</artifactId> | ||
| <version>1.0.0-SNAPSHOT</version> | ||
| </parent> | ||
|
|
||
| </project> |
Git LFS file not shown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,6 @@ | ||||||
| { | ||||||
| "connectionString": "InstrumentationKey=912cbb4e-e606-4c4f-9a00-1731acb15117;IngestionEndpoint=https://eastasia-0.in.applicationinsights.azure.com/;LiveEndpoint=https://eastasia.livediagnostics.monitor.azure.com/;ApplicationId=1efdbec9-ed3f-4e75-a44d-67c6708b6d79", | ||||||
|
There was a problem hiding this comment. The connection string contains sensitive credentials (InstrumentationKey and ApplicationId) that are hardcoded in the configuration file. These credentials should be externalized to environment variables or a secure configuration management system to prevent exposure in version control.
Suggested change
|
||||||
| "role": { | ||||||
| "name": "Espressif-IDE" | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,6 +5,8 @@ | |||||
| package com.espressif.idf.ui.wizard; | ||||||
|
|
||||||
| import java.io.File; | ||||||
| import java.util.HashMap; | ||||||
| import java.util.Map; | ||||||
|
|
||||||
| import org.eclipse.cdt.debug.internal.core.InternalDebugCoreMessages; | ||||||
| import org.eclipse.core.resources.IProject; | ||||||
|
|
@@ -40,8 +42,10 @@ | |||||
| import com.espressif.idf.core.LaunchBarTargetConstants; | ||||||
| import com.espressif.idf.core.build.IDFLaunchConstants; | ||||||
| import com.espressif.idf.core.logging.Logger; | ||||||
| import com.espressif.idf.core.logging.TelemetryLogger; | ||||||
| import com.espressif.idf.core.util.ClangFormatFileHandler; | ||||||
| import com.espressif.idf.core.util.ClangdConfigFileHandler; | ||||||
| import com.espressif.idf.core.util.EclipseIniUtil; | ||||||
|
There was a problem hiding this comment. The import for EclipseIniUtil is added but not used in the visible code changes. This unused import should be removed unless it's used elsewhere in the method.
Suggested change
|
||||||
| import com.espressif.idf.core.util.LaunchUtil; | ||||||
| import com.espressif.idf.ui.UIPlugin; | ||||||
| import com.espressif.idf.ui.handlers.EclipseHandler; | ||||||
|
|
@@ -113,6 +117,11 @@ | |||||
| IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName); | ||||||
| selProvider.setSelection(new StructuredSelection(project)); | ||||||
| updateClangFiles(project); | ||||||
|
|
||||||
| //update telemetry | ||||||
| Map<String, String> properties = new HashMap<String, String>(); | ||||||
|
There was a problem hiding this comment. [nitpick] Use diamond operator for better code readability:
Suggested change
|
||||||
| properties.put("platform", "eclipse"); | ||||||
| TelemetryLogger.logEvent("New project creation", properties); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
|
|
@@ -201,7 +210,7 @@ | |||||
| } | ||||||
|
|
||||||
| IDFProjectGenerator generator = new IDFProjectGenerator(manifest, selectedTemplate, true, | ||||||
| projectCreationWizardPage.getSelectedTarget()); | ||||||
|
Check warning on line 213 in bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/NewIDFProjectWizard.java
|
||||||
| generator.setProjectName(projectCreationWizardPage.getProjectName()); | ||||||
| if (!projectCreationWizardPage.useDefaults()) | ||||||
| { | ||||||
|
|
@@ -216,73 +225,73 @@ | |||||
| private String target; | ||||||
|
|
||||||
| public TargetSwitchJob(String target) | ||||||
| { | ||||||
| super(TARGET_SWITCH_JOB); | ||||||
| this.target = target; | ||||||
| launchBarManager = UIPlugin.getService(ILaunchBarManager.class); | ||||||
| } | ||||||
|
|
||||||
| private Job findInternalJob() | ||||||
| { | ||||||
| for (Job job : Job.getJobManager().find(null)) | ||||||
| { | ||||||
| if (job.getName().equals(InternalDebugCoreMessages.CoreBuildLaunchBarTracker_Job)) | ||||||
| { | ||||||
| return job; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| return null; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| protected IStatus run(IProgressMonitor monitor) | ||||||
| { | ||||||
| Job job = findInternalJob(); | ||||||
| if (job != null) | ||||||
| { | ||||||
| try | ||||||
| { | ||||||
| job.join(); | ||||||
| } | ||||||
| catch (InterruptedException e1) | ||||||
| { | ||||||
| Logger.log(e1); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| Display.getDefault().syncExec(() -> { | ||||||
| ILaunchTarget launchTarget = findSuitableTargetForSelectedTargetString(); | ||||||
| try | ||||||
| { | ||||||
| launchBarManager.setActiveLaunchTarget(launchTarget); | ||||||
| } | ||||||
| catch (CoreException e) | ||||||
| { | ||||||
| Logger.log(e); | ||||||
| } | ||||||
| }); | ||||||
|
|
||||||
| return Status.OK_STATUS; | ||||||
|
|
||||||
| } | ||||||
|
|
||||||
| private ILaunchTarget findSuitableTargetForSelectedTargetString() | ||||||
| { | ||||||
| ILaunchTargetManager launchTargetManager = UIPlugin.getService(ILaunchTargetManager.class); | ||||||
| ILaunchTarget[] targets = launchTargetManager | ||||||
| .getLaunchTargetsOfType(IDFLaunchConstants.ESP_LAUNCH_TARGET_TYPE); | ||||||
|
|
||||||
| for (ILaunchTarget iLaunchTarget : targets) | ||||||
| { | ||||||
| String idfTarget = iLaunchTarget.getAttribute(LaunchBarTargetConstants.TARGET, null); | ||||||
| if (idfTarget.contentEquals(target)) | ||||||
| { | ||||||
| return iLaunchTarget; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| return null; | ||||||
|
Check warning on line 294 in bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/NewIDFProjectWizard.java
|
||||||
| } | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,11 +14,13 @@ | |
| </configIni> | ||
|
|
||
| <launcherArgs> | ||
| <vmArgsLin>-javaagent:resources/applicationinsights-agent-3.6.2.jar | ||
| -Xms2048m -Xmx4096m -Dosgi.requiredJavaVersion=17 [email protected]/workspace | ||
| </vmArgsLin> | ||
| <vmArgsMac>-javaagent:resources/applicationinsights-agent-3.6.2.jar | ||
| -Xms2048m -Xmx4096m -Xdock:icon=../Resources/espressif.icns -XstartOnFirstThread -Dosgi.requiredJavaVersion=17 -Dorg.eclipse.swt.internal.carbon.smallFonts [email protected]/workspace | ||
| </vmArgsMac> | ||
| <vmArgsWin>-javaagent:resources/applicationinsights-agent-3.6.2.jar -Xms2048m -Xmx4096m -Dosgi.requiredJavaVersion=17 [email protected]/workspace | ||
| </vmArgsWin> | ||
| </launcherArgs> | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Calling flush() after every event can impact performance as it forces immediate transmission. Consider batching events or using async transmission, especially if this method will be called frequently.