Welcome to XDA

Search to go directly to your device's forum

Register an account

Unlock full posting privileges

Ask a question

No registration required
Post Reply

Learn to logcat like a Pro!

OP lanternslight456

6th December 2011, 08:12 AM   |  #1  
lanternslight456's Avatar
OP Senior Member
Thanks Meter: 520
 
866 posts
Join Date:Joined: Jan 2011
More
adb logcat bootcamp

I'm going to be teaching the basics of logcats. I sat for a few hours a while back and hammered all this stuff out with ckisgen from XDA/ACS holding my hand the whole way, so this is good info here. I see lots of posts about issues people have and no logcats accompanying them. A good logcat is fried gold to a dev troubleshooting a problem. I did the whole thing in Ubuntu (Linux) and have listed the Window$ $pecific desktop pathing below the Linux command. UNIVERSAL COMMANDS LINUX COMMANDS WINDOWS COMMANDS.

When I say Terminal, I mean Command Prompt for you Window$ u$er$ (start-run-cmd)

In terminal with your phone plugged into the computer


A Logcat:

Code:
adb logcat
This doesn't START logcat, this tells terminal to grab the information already on the device logcat and display it in terminal. This isn't so useful to us. It just scrolls the information in terminal and you can read it there. This is kinda difficult to read though, for one it's constantly scrolling as your phone does things and two, it's likely that your terminal is configured to only allow a certain number of lines to be kept readable before they drop off.


Pipe it to Desktop as a .txt file


Code:
adb logcat > ~/Desktop/logcat.txt 
adb logcat > %userprofile%\desktop\logcat.txt

This command above will tell the logcat to export the terminal logcat to a .txt file on your desktop called logcat.txt The '>' symbol tells the logcat to pipe to the location listed. This will continue to update even if you open the text file, so long as you have terminal running. It's not done “live” though, you have to either refresh the file, or close it then re-open it. That won't affect anything other than giving you an update. Now we're getting somewhere, but where?


Code:
adb logcat > /sdcard/logcat.txt

If using Terminal Emulator on your phone instead of a computer setup, this (above) is the code you'd want to use. It will save the logcat.txt to the root of your SD card. Next!


-v long, or not to -v long, that is the question!


Code:
adb logcat -v long > ~/Desktop/logcat.txt
adb logcat -v long > %userprofile%\desktop\logcat.txt

Now we're telling the logcat to do something more interesting. We are telling it to give us every scrap of information it has. This will space the logcat out nice and pretty and really make things easier to read as well, even giving time stamps of when everything happened! Now you can say “it happened at about 9:30 pm” and we can find that. Winning!
Sometimes you want to filter down the information though. You want to make the dev's life easier. Here is how:

First, a brief on Tags and Priorities.

Tags are going to be what process is actually giving the information, for example 'ActivityManager', 'Database', and 'WindowsManager' are all Tags you can find. There are TONS of these suckers! Research into what your problem is and try to pick out the tag.

Priorities are different. These will tell you how serious the issue at hand is. The priorities are called by their letter code and are:

V Verbose
D Debug
I Info
W Warning
E Error
F Fatal

S Silent (suppress all output)

These are in ascending order. In other words, Verbose or V is going to be the micro information which doesn't really mean much to anyone 99.99% of the time where as Fatal or F is going to be a huge catastrophic issue. When filtering for a Priority it will include the Priority you give PLUS all HIGHER Priorities. So, for example, if you call to filter for Warning or W then it will give you Warning, Error, and Fatal. That is common to filter for. Below are some examples of code:

( PS - you would never actually type or input ‘{‘ or ‘}’ in your logcat commands .. they are in some of the examples below to show you that these are generic modifiers … meaning - if you were actually inputting the command you would replace the {Tag} with an actual Tag, like: ActivityManager or GTalkService .. in the same way you would replace {Priority} with an actual Priority, such as: W or E )


Examples


Code:
adb logcat {Tag}:{Priority} *:S > ~/Desktop/logcat.txt
adb logcat {Tag}:{Priority} *:S > %userprofile%\desktop\logcat.txt

The above line is if you know exactly what Tag (GTalkService or ActivityManager) and Priority (W or E) you are looking for.


Code:
adb logcat *:{Priority} *:S > ~/Desktop/logcat.txt
adb logcat *:{Priority} *:S > %userprofile%\desktop\logcat.txt

The above line is if you don't know the Tag, but know the Priority. The * is a wild card that basically means all/any. An example of a VERY valuable logcat could be:


Code:
adb logcat *:W *:S > ~/Desktop/logcatALLwarnings.txt
adb logcat *:W *:S > %userprofile%\desktop\logcat.txt

So, the command above would give you all tags that had a priority of Warning, Error, or Fatal. It would silence (not show) everything else and would pipe the output of your log to your desktop as a text file named logcatALLwarnings.txt … moving along …


Code:
adb logcat {Tag}:V *:S > ~/Desktop/logcat.txt
adb logcat {Tag}:V *:S > %userprofile%\desktop\logcat.txt

The above line is if you know the Tag but want to see all Priorities. {Tag}:V outputs all priorities for the specific Tag you’ve entered because it calls for the V (Verbose) priority, which is the very lowest priority … and as you recall, it always gives you the priority you’ve asked for AND above.

The *:S tells the logcat to Silence (or ignore) all lines/messages that have not otherwise been specifically called for using these filter expressions. This CAN cause issues though, sometimes it will silence what you're looking for / everything.

A final specific example from my phone to be clear. I got a Database Tag with an Info Priority, if I wanted to see all instances of this happening, I could use the following code:


Code:
adb logcat Database:I *:S > ~/Desktop/logcat.txt
adb logcat Database:I *:S > %userprofile%\desktop\logcat.txt

Or, if I had an ActivityManager Warning I could use


Code:
adb logcat ActivityManager:W *:S > ~/Desktop/logcat.txt
adb logcat ActivityManager:W *:S > %userprofile%\desktop\logcat.txt

Ok, now we're going to the show! You know the tools, but how do I use them? Glad you asked!

For the first time you boot a ROM/Kernel bundled together (IE InsomMIUI 1.12.2) or for just a kernel you're going to do the following:

Once you're finished full wiping and installing the ROM, but haven't rebooted the phone yet. (Or wiping just the caches for a separate Kernel):
  • Open Terminal on your computer
  • enter the following code
Code:
adb logcat -v long > ~/Desktop/logcat.txt
adb logcat -v long > %userprofile%\desktop\logcat.txt
[INDENT=2]
[/INDENT]
  • Name the logcat something useful. A good format is to use you're initials, rom name, what it is, and date. This way it stands out. So the code with the really long but helpful file name would be:
Code:
adb logcat -v long > ~/Desktop/JH_InsomMIUI1122_firstboot_5Dect11.txt
adb logcat -v long > %userprofile%\desktop\JH_InsomMIUI1122_firstboot_5Dect11.txt
  • Yes, I know that's a long name, but we look at dozens of these things, it helps!
    • In recovery tell it to reboot the phone. The logcat will start recording internally on your device at boot automatically.
    • Once the phone is at the lockscreen let it sit for 5 minutes.
    • Unlock the phone and let it sit for about 10 seconds.
    • Restart the phone.
    • Once you restart the phone open the logcat file on your desktop to make sure it’s not blank/empty/something went wrong and if everything’s golden - send to your favorite developer (ME! ).

  • FYI , the -v option sets the output format. -v long after the logcat command formats the log so that it adds a date and time stamp to each line. It also separates each line with a blank line .. making the log as a whole much easier to look through.

  • That's it, you should be off to the races with these logcats. I hope this has helped!
The Following 108 Users Say Thank You to lanternslight456 For This Useful Post: [ View ]
29th March 2012, 12:44 AM   |  #2  
tdizzle404's Avatar
Senior Member
Flag North Georgia
Thanks Meter: 1,095
 
4,510 posts
Join Date:Joined: Nov 2010
Donate to Me
More
Wow this is great I hope People make use of this.
The Following User Says Thank You to tdizzle404 For This Useful Post: [ View ]
29th March 2012, 01:13 AM   |  #3  
lanternslight456's Avatar
OP Senior Member
Thanks Meter: 520
 
866 posts
Join Date:Joined: Jan 2011
More
Glad you like it :)

this has been a message from the dead pool.
29th March 2012, 03:46 AM   |  #4  
afbengochea's Avatar
Senior Member
Thanks Meter: 112
 
600 posts
Join Date:Joined: Jan 2012
Im still very much a noob and dont like posting unless necessary but would like to help when I can. Is there a way to do this on a mac?
29th March 2012, 06:34 AM   |  #5  
lanternslight456's Avatar
OP Senior Member
Thanks Meter: 520
 
866 posts
Join Date:Joined: Jan 2011
More
It should be really similar to linux. You'll have to have the sdk installed and running which I don't know how to do on mac but the commands should be similar. Let me look into it.

this has been a message from the dead pool.
29th March 2012, 11:13 AM   |  #6  
Senior Member
Flag Satu Mare
Thanks Meter: 11
 
156 posts
Join Date:Joined: Mar 2012
More
hy,

Realy nice tutorial.
Can you make a tutorial to how to use logcat from terminal emulator from phone?
29th March 2012, 01:16 PM   |  #7  
Rakkesh27's Avatar
Senior Member
Flag Chennai
Thanks Meter: 38
 
198 posts
Join Date:Joined: Mar 2012
More
Nice info. thanks
29th March 2012, 01:27 PM   |  #8  
Guru Zeb's Avatar
Senior Member
Flag Up North !!!!!!!!!
Thanks Meter: 34
 
122 posts
Join Date:Joined: Jan 2012
Good post m8
One minor criticism, not just of this post but many "How to's" on this forum.

A clear description of what a logcat is and how it maybe useful would go a long way to help educate the inexperienced.
I only say this as i have non techy friends who constantly complain about this issue.
They go looking for info to sort their own issues out and are confronted with jargon on jargon on jargon ..... with no 'Plain English explanation"
We should all try to remember not everyone possesses the same tech knowledge, and we all where N00bs once we only ascended to being the godlike superusers we are due to others making knowledge clearly available to us.
Th idea that "if you don't understand then this isn't for you" is pretty narrow and arrogant.
The Following 5 Users Say Thank You to Guru Zeb For This Useful Post: [ View ]
26th April 2012, 09:11 PM   |  #9  
Member
Thanks Meter: 5
 
43 posts
Join Date:Joined: Nov 2009
More
When I run logcat on my phone, using the command

Code:
adb logcat -v long > /sdcard/logcat.txt

the next line display is

Code:
- waiting for device -

and then does nothing. What am I doing wrong?
The Following User Says Thank You to PrinceFX For This Useful Post: [ View ]
30th April 2012, 03:08 PM   |  #10  
Jamison904's Avatar
Senior Member
Jacksonville, Florida
Thanks Meter: 14,727
 
5,348 posts
Join Date:Joined: Jun 2009
Donate to Me
More
Adb doesn't see your devices. Do you have debugging turned on in settings? If you do try:
Code:
adb devices
If you don't see anything you don't have debugging turned on or you don't have the drivers installed for your devices. Or it isn't plugged in.

The Following User Says Thank You to Jamison904 For This Useful Post: [ View ]
Post Reply Subscribe to Thread
Previous Thread Next Thread
Thread Tools Search this Thread
Search this Thread:

Advanced Search
Display Modes