3.3.1 EMC APIs
- Piotr Mrozek
You can troubleshoot both the EMCD and the EMCI by looking into the logs these applications create. By default the logs are saved in the directory:
/var/log/emc
Each log file name consists of 3 parts:
1. API's name: emcd or emci.
2. API's process ID.
3. Creation date.
This denotes that the file contains EMCD logs for EMCD's process ID 24762 created 2015-09-25.
The same structure applies to the EMCI log files.
Structure of a log file
Each line in the log consists of 7 parts:
1. Date.
2. Timestamp (the time when the log was saved).
3. Source IP address (the IP address of the application that performed the logged action, i.e. the Android dialer).
4. Platform (Android, iOS, BlackBerry, etc.).
5. Session ID (ID of a particular session within the API).
6. Log level (INFO, DEBUG, WARNING, ERROR, etc.).
7. Log itself.
Reading logs
When you open a log file, you'll see there is a lot of information there. To extract the desired information you should filter the log by using the grep tool available in the linux system. In the command line type for example:
cat emcd.[24762].2015-09-25.txt | grep '12.34.56.78'
This command will display the whole file (cat tool) and filter only the lines with the '12.34.56.78' sequence (it's an IP address). The result can be as follows:
2015-09-25 15:14:12,667 12.34.56.78 and 679FD43BA7DBD0A59372F111 INFO BalanceHandler – Request:l=48510897090&p=abcdefghijkl
It reads that the line is from 25th September 2015, saved at 15:14:12,667, from the IP address 12.34.56.78, from an Android dialer, with a session ID 679FD43BA7DBD0A59372F111, this is an information level (it is neither a warning nor an error) and it shows that the Android application sent request for the balance of a user with login 48510897090 and password abcdefghijkl.
This was an example of filtering by IP address, but you can filter by any part of the logs (date, time, IP, platform, session ID, log level, log itself).
Once you see the session ID, you can filter by it to see the whole process containing the softphone's request and the server response, i.e.:
cat emcd.[24762].2015-09-25.txt | grep '679FD43BA7DBD0A59372F111'
It's a request for logs for the session ID 679FD43BA7DBD0A59372F111 only:
2015-09-25 15:14:12,667 12.34.56.78 and 679FD43BA7DBD0A59372F111 INFO BalanceHandler - Request:l=48510897090&p=abcdefghijkl
2015-09-25 15:14:12,667 12.34.56.78 and 679FD43BA7DBD0A59372F111 DEBUG BalanceHandler - UserAgent:vippie;and;1.0.20
2015-09-25 15:14:12,668 12.34.56.78 and 679FD43BA7DBD0A59372F111 DEBUG CacheService - Retrieving item [CurrentClient/vippie/48510897060] from cache.
2015-09-25 15:14:12,668 12.34.56.78 and 679FD43BA7DBD0A59372F111 DEBUG CacheService - Adding item [CurrentClient/vippie/48510897060] to cache with sliding expiry window in seconds [10800].
2015-09-25 15:14:12,668 12.34.56.78 and 679FD43BA7DBD0A59372F111 DEBUG BalanceHandler - X-VIPPIE-DEVICE-ID:dadd2014-78b0-1350-f0e6-d0feb7c0d4da, X-VIPPIE-DEVICE-NAME:SM-G800F
2015-09-25 15:14:12,668 12.34.56.78 and 679FD43BA7DBD0A59372F111 DEBUG CacheService - Retrieving item [CurrentDevice/1030/dadd2014-78b0-1350-f0e6-d0feb7c0d4da] from cache.
2015-09-25 15:14:12,668 12.34.56.78 and 679FD43BA7DBD0A59372F111 DEBUG CacheService - Adding item [CurrentDevice/1030/dadd2014-78b0-1350-f0e6-d0feb7c0d4da] to cache with sliding expiry window in seconds [10800].
2015-09-25 15:14:12,680 12.34.56.78 and 679FD43BA7DBD0A59372F111 INFO BalanceHandler - Result:{"bt":"$10.5000","bv":10.5000,"bc":"USD"}
It's a request for a balance of a user with the login 48510897090 and you can see that the requested balance is 10.50$ (the last line).
Note: it's handy to use the tail tool, which lets you read the logs live, i.e.:
tail -f emcd.[24762].2015-09-25.txt | grep '679FD43BA7DBD0A59372F111'
It'll keep displaying you all the new lines being added to the file emcd.[24762].2015-09-25.txt for the session ID 679FD43BA7DBD0A59372F111 only.
What you can read in the logs
There are 3 types of files:
- emcd.[process_id].date.txt
This file stores all the logs saved by the EMCD. You can read everything from there related to:
◦ avatars,
◦ active address book,
◦ balance,
◦ rates,
◦ registration,
◦ log in process,
◦ plans,
◦ DIDs,
◦ groupchat,
◦ attachments,
◦ find friends,
◦ local dialing plan.
2. emci.[process_id].date.txt
This file stores all the logs saved by the EMCI. You can read everything from there related to:
◦ registration via VUP only,
◦ log in via VUP only,
◦ PUSH,
◦ buddy list (request from VoipSwitch to get to know, who is your buddy, so that it can send you their presence).
3. emcd/emci.[process_id].error.date.txt
This 3rd type of file is the file that stores only errors saved in the main file, so that you can have a look only at the errors right away, without any need for filtering.