Using Pinpoint Cloud

Available in Classic and VPC

Describes how to use the Pinpoint Cloud web console and how to integrate applications using Pinpoint Agent. The Pinpoint Cloud web console lets you monitor the performance of your applications. The Pinpoint Cloud web console has the same UI as the open source version of Pinpoint, making it easy for existing Pinpoint users to adapt.

Installing and Managing Agents

To use Pinpoint Cloud, you must install Pinpoint Agent on the application to be monitored.
The Pinpoint Agent runs as a Java Agent connected to the application to be monitored (e.g. Tomcat). To connect Pinpoint Agent to a monitored application, you must forward $AGENT_PATH/pinpoint-bootstrap-$VERSION.jar to the -javaagent JVM argument when the application runs.

Installing Agents

To install Pinpoint Agent, configure the appropriate environment variables and download the link to your PC. Follow these steps to install Pinpoint Agent:

1. In the NAVER Cloud Platform console, click > Services > Management & Governance > Pinpoint Cloud menu in order.
2. Click the [Shortcut] button for the desired repository from the list.
3. After logging in to the web console, click in the top right corner and go to the Installation menu.
4. Configure the following environment variables for your Agent.
   • Application Name: Enter the application group ID and click [Check]
   • Agent ID: Enter the application ID and click [Check]
5. Once the JVM argument is configured with the information entered, click to copy the code.
   • Remember to add this code to your application's launch options later.
6. Click the Download Link to download the zipped file.
7. After unzipping the downloaded Agent file, finish configuring your launch option and license key settings for the application to be monitored.
   • Configuring your launch option settings: Example: For Tomcat, modify the Tomcat startup script in the $CATALINA_HOME/bin/catalina.sh file as shown below, then save the file.

   CATALINA_OPTS="$CATALINA_OPTS -javaagent:$AGENT_PATH/pinpoint-bootstrap-$VERSION.jar"
   CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.agentId=$AGENT_ID"
   CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.applicationName=$APPLICATION_NAME"
   

   • Configuring your license key settings: Move your cursor over the Agent License Key and click to copy the license key, then paste it into the $AGENT_PATH/pinpoint.license file and save it.
8. Run the application.
   • Once installed, the Pinpoint Agent collects your application’s performance data.

Adjusting Pinpoint log levels

To adjust the log level for each Pinpoint component, modify the log4j.xml file as shown below.

(omitted)
<logger name="com.navercorp.pinpoint" additivity="false">
    <level value="WARN"/>
    <appender-ref ref="console"/>
</logger>

<logger name="com.navercorp.pinpoint.web.filter" additivity="false">
    <level value="WARN"/>
    <appender-ref ref="console"/>
</logger>

<logger name="com.navercorp.pinpoint.web.controller" additivity="false">
    <level value="WARN"/>
    <appender-ref ref="console"/>
</logger>

<logger name="com.navercorp.pinpoint.web.applicationmap" additivity="false">
    <level value="WARN"/>
    <appender-ref ref="console"/>
</logger>

<logger name="com.navercorp.pinpoint.web.calltree.server" additivity="false">
    <level value="WARN"/>
    <appender-ref ref="console"/>
</logger>

<logger name="com.navercorp.pinpoint.web.mapper" additivity="false">
    <level value="WARN"/>
    <appender-ref ref="console"/>
</logger>

<logger name="com.navercorp.pinpoint.web.service" additivity="false">
    <level value="WARN"/>
    <appender-ref ref="console"/>
</logger>
(omitted)

Key Features

This is a quick guide to the main features of the Pinpoint Cloud web console.

Server Map

The Server Map displays the configuration of your distributed system. Click on a node to show the current status, transaction count, and other details for a component.

Call Stack

The Call Stack lets you view system transactions at the code level to quickly identify bottlenecks and failure points and instantly check application errors and exceptions.

Select a transaction recorded in the Server Map’s scatter chart to display a Call Stack as shown below.

Application Inspector

The Application Inspector allows you to check your application's resource data (stat: CPU, Memory, TPS, datasource connection count).

• Drag the cursor across a specific area on the chart to zoom in to the selected area.
• While zoomed in, you can click the [Reset Zoom] button to zoom back out.

Settings Menu

You can access the settings menu by clicking in the Pinpoint Cloud web console. The available settings menus are as follows.

Managing Users

Manage user accounts created for the repository web console.

Adding Users

To add a new user, follow the steps below.

1. In the Pinpoint Cloud web console, go to > Users.
2. Click at the top of the user list.
3. Enter user information, then click the [Save] button.
   • User roles can be set in the Role menu. To create a new role, see Creating Roles.

Deleting Users

To delete a user, follow the steps below.

1. In the Pinpoint Cloud web console, go to > Users.
2. From the list of users, click for the user you want to delete.
3. Click the [Delete] button.

Managing Roles

You can manage roles and permissions for users of the repository web console.

Creating Roles

To create a new role, follow the steps below.

1. In the Pinpoint Cloud web console, go to > Role.
2. Click at the top of the roles list.
3. Enter a name for the role, select permissions to grant, and click the [Save] button.

Deleting Roles

To delete a role, follow the steps below:

1. In the Pinpoint Cloud web console, go to > Role.
2. From the list of roles, click the of the role you want to delete.
3. Click the [Delete] button.

Managing User Groups

You can group users together to specify which applications they can use and set multiple users as alarm recipients at once.

Viewing User Groups

You can view a list of user groups and the details for each group. To view a user group, follow the steps below.

1. In the Pinpoint Cloud web console, go to > User Group.
2. Check your group information on the User Group interface.
   
   • User Group: List of User Groups
     • Clicking an item in the list displays a list of members who belong to that group in Group Member.
     • You can create a new user group by clicking .
     • You can delete a user group by clicking .
   • Group Member: A list of members in the selected group
     • You can remove a member from the group by clicking > .
   • Pinpoint User: A list of all registered users for the Pinpoint Cloud web console
     • While a group is selected, clicking the checkbox in front of a user's name to select them will add that user as a group member.
     • Click on a username to see the profile details.
   • Application Authentication & Alarm: A list of applications assigned to the selected group
     • You can check application permissions by clicking in the Detail field.
     • You can navigate to the Authentication & Alarm menu by clicking in the More field.

Creating User Groups

To create a new user group and add members, follow the steps below.

1. In the Pinpoint Cloud web console, go to > User Group.
2. Click at the top of the User Group list.
3. Enter a name for the user group, and then click the [OK] button.
4. Click the created user group, then select members to be added from the Pinpoint User list by clicking their checkboxes.
   • Users selected this way are added to the Group Member list.

Application Permissions and Notification Settings

You can grant permissions to user groups for applications registered in the Pinpoint Cloud web console and set up event notifications.

Set user permissions

To set permissions for your application and grant them to groups of users, follow the steps below.

1. In the Pinpoint Cloud web console, go to > Authentication & Alarm.
2. In the Application list, click the application you want to grant permissions to.
3. Click at the top of the Authentication list.
4. After selecting the user group IDs and positions to grant permissions to, configure data visibility and click the [OK] button.
   • The permission configurations are now added to the list.
     • Click to see whether the data is visible to other parties.
     • Click to change positions and data visibility.
     • You can delete permission configurations by clicking > .

Notification Settings

You can set an alarm to send an SMS/email when a certain metric threshold is exceeded. The following metric items are available for alarm configuration.

To set up notifications to send to a group of users when an event occurs, follow the steps below.

1. In the Pinpoint Cloud web console, go to > Authentication & Alarm.
2. Click at the top of the Alarm list.
3. After configuring alarms and thresholds, select the user group ID to receive the alarm and the alarm format, then click [OK].
   • The alarm contents are now added to the list.
     • You can change the contents of the alarm by clicking .
     • You can delete the contents of the alarm by clicking > .