[GR-25052] [GR-24895] Maven artifact for Insight is called agent script.

PullRequest: graal/6944

Author: Jaroslav Tulach

tools/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This changelog summarizes major changes between Truffle Tools versions.
 
+## Version 20.3.0
+
+* [GraalVM Insight](docs/Insight.md) Maven artifact is now `org.graalvm.tools:insight:20.3.0`
+
 ## Version 20.2.0
 
 * [GraalVM Insight](docs/Insight-Manual.md#modifying-local-variables) can modify values of local variables

tools/docs/Insight-Embedding.md

@@ -11,7 +11,7 @@ Read on to learn how to embed [Insight](Insight.md) into your own application.
 [Context](https://www.graalvm.org/sdk/javadoc/org/graalvm/polyglot/Context.html) API.
 [Insight](Insight-Manual.md) isn't an exception and it can also be
 controlled via the same API as well. See
-[AgentScript class documentation](https://www.graalvm.org/tools/javadoc/com/oracle/truffle/tools/agentscript/AgentScript.html)
+[formal Insight documentation](https://www.graalvm.org/tools/javadoc/org/graalvm/tools/insight/Insight.html)
 for more details:
 
 ```java

tools/docs/Insight-Manual.md

@@ -45,18 +45,18 @@ As such, whenever the *node.js* framework loaded a script,
 the listener got notified of it and could take an action - in this case
 printing the length and name of processed script.
 
-### Histogram - Use Full Power of Your Language!
+### Hotness Top 10 - Use Full Power of Your Language!
 
 Collecting the insights information isn't limited to simple print statement.
 One can perform any Turing complete computation in your language. Imagine
-following `function-histogram-tracing.js` that counts all method invocations
+following `function-hotness-tracing.js` that counts all method invocations
 and dumps the most frequent ones when the execution of your program is over:
 
 ```js
 var map = new Map();
 
-function dumpHistogram() {
-    print("==== Histogram ====");
+function dumpHotness() {
+    print("==== Hotness Top 10 ====");
     var digits = 3;
     Array.from(map.entries()).sort((one, two) => two[1] - one[1]).forEach(function (entry) {
         var number = entry[1].toString();
@@ -67,7 +67,7 @@ function dumpHistogram() {
         }
         if (number > 10) print(`${number} calls to ${entry[0]}`);
     });
-    print("===================");
+    print("========================");
 }
 
 insight.on('enter', function(ev) {
@@ -82,18 +82,18 @@ insight.on('enter', function(ev) {
     roots: true
 });
 
-insight.on('close', dumpHistogram);
+insight.on('close', dumpHotness);
 ```
 
 The `map` is a global variable visible for the whole **Insight** script that 
-allows the code to share data between the `insight.on('enter')` function and the `dumpHistogram`
+allows the code to share data between the `insight.on('enter')` function and the `dumpHotness`
 function. The latter is executed when the `node` process execution is over (registered via
-`insight.on('close', dumpHistogram)`. Invoke as:
+`insight.on('close', dumpHotness)`. Invoke as:
 
 ```bash
-$ graalvm/bin/node --experimental-options --js.print --insight=function-histogram-tracing.js -e "print('The result: ' + 6 * 7)"
+$ graalvm/bin/node --experimental-options --js.print --insight=function-hotness-tracing.js -e "print('The result: ' + 6 * 7)"
 The result: 42
-=== Histogram ===
+==== Hotness Top 10 ====
 543 calls to isPosixPathSeparator
 211 calls to E
 211 calls to makeNodeErrorWithCode
@@ -111,7 +111,7 @@ The result: 42
  13 calls to copyPrototype
  13 calls to hideStackFrames
  13 calls to addReadOnlyProcessAlias
-=================
+========================
 ```
 
 Table with names and counts of function invocations is printed out when the
@@ -355,7 +355,7 @@ R: observed loading of test.R
 
 The only change is the R language. All the other [Insight](Insight.md)
 features and 
-[APIs](https://www.graalvm.org/tools/javadoc/com/oracle/truffle/tools/agentscript/AgentScript.html#VERSION)
+[APIs](https://www.graalvm.org/tools/javadoc/org/graalvm/tools/insight/Insight.html#VERSION)
 remain the same.
 
 ### Inspecting Values
@@ -448,9 +448,9 @@ instrument. Never the less, the compatibility of the **Insight** API
 exposed via the `insight` object
 is treated seriously.
 
-The [documentation](https://www.graalvm.org/tools/javadoc/com/oracle/truffle/tools/agentscript/AgentScript.html)
+The [documentation](https://www.graalvm.org/tools/javadoc/org/graalvm/tools/insight/Insight.html)
 of the `insight` object properties and functions is available as part of its
-[javadoc](https://www.graalvm.org/tools/javadoc/com/oracle/truffle/tools/agentscript/AgentScript.html#VERSION).
+[javadoc](https://www.graalvm.org/tools/javadoc/org/graalvm/tools/insight/Insight.html#VERSION).
 
 Future versions will add new features, but whatever has
 once been exposed, remains functional. If your script depends on some fancy new
@@ -461,7 +461,7 @@ print(`GraalVM Insight version is ${insight.version}`);
 ```
 
 and act accordingly to the obtained version. New elements in the
-[documentation](https://www.graalvm.org/tools/javadoc/com/oracle/truffle/tools/agentscript/AgentScript.html)
+[documentation](https://www.graalvm.org/tools/javadoc/org/graalvm/tools/insight/Insight.html)
 carry associated `@since` tag to describe the minimimal version the associated
 functionality/element is available since.
 

tools/docs/Insight.md

@@ -8,6 +8,7 @@ hooks on already deployed applications running at full speed.
 code once, apply your insights anytime, anywhere!
 
 Find out what **Insight** offers from a [tools change log](../CHANGELOG.md),
+from a [formal API specification](https://www.graalvm.org/tools/javadoc/org/graalvm/tools/insight/Insight.html),
 by checking the [Insight Hacker's manual](Insight-Manual.md)
 or by reading on...
 

tools/mx.tools/mx_tools.py

@@ -214,14 +214,14 @@ def _tools_gate_runner(args, tasks):
 
 mx_sdk_vm.register_graalvm_component(mx_sdk_vm.GraalVmTool(
     suite=_suite,
-    name='AgentScript',
-    short_name='ats',
-    dir_name='agentscript',
+    name='Insight',
+    short_name='insight',
+    dir_name='insight',
     license_files=[],
     third_party_license_files=[],
     dependencies=['Truffle'],
-    truffle_jars=['tools:AGENTSCRIPT'],
-    support_distributions=['tools:AGENTSCRIPT_GRAALVM_SUPPORT'],
+    truffle_jars=['tools:INSIGHT'],
+    support_distributions=['tools:INSIGHT_GRAALVM_SUPPORT'],
     priority=10,
     include_by_default=True,
 ))

tools/mx.tools/suite.py

@@ -96,7 +96,7 @@
             "annotationProcessors" : ["truffle:TRUFFLE_DSL_PROCESSOR"],
             "workingSets" : "Tools",
         },
-        "com.oracle.truffle.tools.agentscript.test" : {
+        "org.graalvm.tools.insight.test" : {
             "subDir" : "src",
             "sourceDirs" : ["src"],
             "dependencies" : [
@@ -342,10 +342,10 @@
                 "native-image.properties" : "file:mx.tools/tools-chromeinspector.properties",
             },
         },
-        "AGENTSCRIPT": {
+        "INSIGHT": {
             "subDir": "src",
             # This distribution defines a module.
-            "moduleName" : "com.oracle.truffle.tools.agentscript",
+            "moduleName" : "org.graalvm.tools.insight",
             "dependencies": [
                 "org.graalvm.tools.insight",
                 "com.oracle.truffle.tools.agentscript"
@@ -354,27 +354,27 @@
                 "truffle:TRUFFLE_API",
             ],
             "maven" : {
-              "artifactId" : "agentscript",
+              "artifactId" : "insight",
             },
-            "description" : "Script driven tracing and instrumentation Agent",
+            "description" : "The Ultimate Insights Gathering Platform",
         },
-        "AGENTSCRIPT_TEST": {
+        "INSIGHT_TEST": {
             "subDir": "src",
             "dependencies": [
-                "com.oracle.truffle.tools.agentscript.test",
+                "org.graalvm.tools.insight.test",
             ],
             "distDependencies" : [
                 "truffle:TRUFFLE_TEST",
-                "AGENTSCRIPT",
+                "INSIGHT",
             ],
-            "description" : "Tests for the script driven tracing and instrumentation Agent.",
+            "description" : "Tests for the Ultimate Insights Gathering Platform",
             "maven" : False,
         },
-        "AGENTSCRIPT_GRAALVM_SUPPORT" : {
+        "INSIGHT_GRAALVM_SUPPORT" : {
             "native" : True,
-            "description" : "Script driven tracing and instrumentation Agent for the GraalVM",
+            "description" : "The Ultimate Insights Gathering Platform for the GraalVM",
             "layout" : {
-                "native-image.properties" : "file:mx.tools/tools-agentscript.properties",
+                "native-image.properties" : "file:mx.tools/tools-insight.properties",
             },
         },
         "TRUFFLE_PROFILER": {

tools/mx.tools/tools-agentscript.properties renamed to tools/mx.tools/tools-insight.properties

@@ -22,7 +22,7 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
-package com.oracle.truffle.tools.agentscript.test;
+package org.graalvm.tools.insight.test;
 
 import java.util.function.Function;
 import org.graalvm.polyglot.Context;

tools/src/com.oracle.truffle.tools.agentscript.test/src/com/oracle/truffle/tools/agentscript/test/Embedding.java renamed to tools/src/org.graalvm.tools.insight.test/src/org/graalvm/tools/insight/test/Embedding.java

@@ -22,7 +22,7 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
-package com.oracle.truffle.tools.agentscript.test;
+package org.graalvm.tools.insight.test;
 
 import com.oracle.truffle.api.instrumentation.EventContext;
 import com.oracle.truffle.api.interop.InteropLibrary;

tools/src/com.oracle.truffle.tools.agentscript.test/src/com/oracle/truffle/tools/agentscript/test/EventContextObjectTest.java renamed to tools/src/org.graalvm.tools.insight.test/src/org/graalvm/tools/insight/test/EventContextObjectTest.java

@@ -22,7 +22,7 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
-package com.oracle.truffle.tools.agentscript.test;
+package org.graalvm.tools.insight.test;
 
 // @formatter:off
 import java.util.Map;