Using Pinpoint Cloud

Available in Classic and VPC

How to use the Pinpoint Cloud web console and set up application linkage using the Pinpoint agent are explained. You can monitor application performance on the Pinpoint Cloud web console. Pinpoint Cloud web console has the identical UI as the open source version of Pinpoint, so existing Pinpoint users can easily be familiarized with it.

Install and manage agent

To use Pinpoint Cloud, the Pinpoint agent should be installed in the application to be monitored.
Pinpoint agent is executed as a Java agent connected to the application to be monitored (e.g., Tomcat). To connect the Pinpoint agent to the application to be monitored, $AGENT_PATH/pinpoint-bootstrap-$VERSION.jar must be delivered to the -javaagent JVM argument when the application is executed.

Install agent

To install the Pinpoint agent, you should set up environmental variables and download the link to a PC. The following describes how to install it.

1. From the NAVER Cloud Platform console, click the Services > Management & Governance > Pinpoint Cloud menus, in that order.
2. Click the [Go] button for the repository you want among the list.
3. Log in to the web console, and click , and then click the Installation menu.
4. Enter the environment variable for the agent.
   • Application name: Enter the ID to identify the application group, and then click the [Check] button.
   • Agent ID: Enter the unique ID to identify the application, and then click the [Check] button.
5. Once the JVM argument is configured with the information entered, click to copy the code.
   • The code needs to be added to the execution option of the application later.
6. Click the link under Download link to download the compressed file.
7. Decompress the downloaded agent file, and complete settings for the monitoring target application's execution options and license key.
   • Monitoring target application's execution option settings: <Example> For Tomcat, edit $CATALINA_HOME/bin/catalina.sh which is the starting script of Tomcat, and save it.

   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"
   

   • License key settings: Click , which appears when you hover the mouse over the Agent license key area, to copy the license key, and paste the value in the $AGENT_PATH/pinpoint.license file and save.
8. Run the application.
   • The performance information will be collected through the Pinpoint agent installed.

Adjust Pinpoint log level

Edit the log4j.xml file to adjust each Pinpoint component's log level.

(...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)

Main features

Main features of the Pinpoint Cloud web console are briefly explained.

Server Map

You can see the whole configuration of the distributed system at a glance. You can also click each node to check the details, such as a component's current status and the number of transactions.

Call Stack

It allows you to quickly identify bottleneck or failure points and check errors and exceptions in the application by checking the system transactions at the code level.

Select a transaction recorded on the scatter plot chart of the Server map to see the Call stack page as follows.

Application Inspector

The application's resource data (stat: CPU, memory, TPS, datasource connection count) can be viewed.

• You can drag a certain area from the chart to see the selected chart zoomed in.
• Click the [Reset zoom] button while zoomed in to go back to the original view.

Settings menu

You can click the from the Pinpoint Cloud web console to use the settings menu. The following settings menus are available.

Manage users

You can manage users of the repository web consoles created.

Add user

The following describes how to add a new user.

1. Click the > Users menus on the Pinpoint Cloud web console, in this order.
2. Click at the top of the user list.
3. Enter the user information, and then click the [Save] button.
   • The user role can be set in the Role menu. To create a new role, refer to Create role.

Delete user

The following describes how to delete a user.

1. Click the > Users menus on the Pinpoint Cloud web console, in this order.
2. Click of the user you want to delete from the user list.
3. Click the [Delete] button.

Manage roles

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

Create role

The following shows how to create a new role.

1. Click the > Role menus on the Pinpoint Cloud web console, in this order.
2. Click at the top of the role list.
3. Enter the role's name, select permissions to grant to the role, and then click the [Save] button.

Delete role

The following describes how to delete a role.

1. Click the > Role menus on the Pinpoint Cloud web console, in this order.
2. Click of the role you want to delete from the role list.
3. Click the [Delete] button.

Manage user groups

You can organize added users as a group, specify applications to use it, and set them to be notification recipients at once.

View user group

You can view the list of user groups and details set up by group. The following shows how to view user groups.

1. Click the > User group menus on the Pinpoint Cloud web console, in this order.
2. View the group information from the User group page.
   
   • User group: the list of user groups created
     • Click an item on the list to see the list of members in the group under Group member.
     • Click to create a new user group.
     • Click to delete a user group.
   • Group member: the list of members in the selected group
     • Click > to delete a member from the group.
   • Pinpoint user: the list of all users added on the Pinpoint Cloud web console
     • You can click to select a checkbox in front of the user's name while the group is selected to add the user as the group member.
     • Click a user's name to see their profile details.
   • Application authentication & alarm: the list of applications designated to the selected group
     • You can click of the Detail to see the application permissions.
     • You can click of the More to go to the Authentication & alarm menu.

Create user group

The following describes how to create a new user group and add members.

1. Click the > User group menus on the Pinpoint Cloud web console, in this order.
2. Click at the top of the User group list.
3. Enter the name of the user group, and then click the [OK] button.
4. Click the user group created, and click to select the checkbox of the user you want to add as the member from the Pinpoint user list.
   • The selected user will be added to the Group member list.

Application permission and notification settings

You can grant permissions of the application registered on the Pinpoint Cloud web console to a user group, and set up notifications to sent in case of event occurrence.

Set permissions

The following describes how you can set up an application's permissions and grant them to a user group.

1. Click the > Authentication & alarm menus on the Pinpoint Cloud web console, in this order.
2. Click the application to grant permissions from the Application list.
3. Click at the top of the Authentication list.
4. Select the user group ID and position to grant the permissions, set up whether to disclose data, and click the [OK] button.
   • The details of the permission set up will be added to the list.
     • You can click to see whether data disclosure is set up in the user group.
     • You can click to edit the position and data disclosure status.
     • Click > to delete the permission setup details.

Notification settings

You can configure so that a notification is sent via SMS or email when an indicator threshold is exceeded. The indicators you can set up notifications are as follows.

The following describes how to set up notifications to be sent to a user group if an event occurs.

1. Click the > Authentication & alarm menus on the Pinpoint Cloud web console, in this order.
2. Click at the top of the Alarm list.
3. Set up the alarm item and threshold, and select the user group ID to receive the alarm and notification format, and then click the [OK] button.
   • The details of the alarm will be added to the list.
     • You can click to edit the alarm's details.
     • Click > to delete the alarm details.