How to instrument your code easy and effectively

Transcription

1 How to instrument your code easy and effectively 31 maart 2017 APEX World Rotterdam Sabine Heimsath its-people GmbH

2 Sabine Heimsath Client Senior Database Application Developer PL/SQL, SQL Developer, APEX its-people Portfolio Manager Development Blogger DOAG Member of the Development blog.its-people.de APEX World, 31 maart 2017 Sabine Heimsath 2

3 Instrumentation why? No matter who you are or how cool you think you are at programming, you can never know exactly what is going on in your code unless you instrument it. Just shut up and do it! Tim Hall APEX World, 31 maart 2017 Sabine Heimsath 3

4 APEX World, 31 maart 2017 Sabine Heimsath 4

5 Definitions I have one AOL friend that says adding lines to code is debug code (meaning bad), while others say it is instrumentation (meaning good) Chet Justice APEX World, 31 maart 2017 Sabine Heimsath 5

6 We want to know what it s doing, how it s doing it, how long it took and how much it costs Debugging fixing coding errors or logic APEX World, 31 maart 2017 Sabine Heimsath 6

7 We want to know what it s doing, how it s doing it, how long it took and how much it costs Debugging Logging a type of auditing or operational tracking of a task or set of tasks APEX World, 31 maart 2017 Sabine Heimsath 7

8 We want to know what it s doing, how it s doing it, how long it took and how much it costs set services, client id, client info, Runtime registration module and action in V$ views, extended SQL trace file and AWR and ASH interfaces APEX World, 31 maart 2017 Sabine Heimsath 8

9 We want to know what it s doing, how it s doing it, how long it took and how much it costs Metric collection CPU and I/O that the users of an application are generating, ASH, AWR APEX World, 31 maart 2017 Sabine Heimsath 9

10 Some general recommendations APEX World, 31 maart 2017 Sabine Heimsath 10

11 1 Wrap your Transaction Control Statements Useful for Long running transformations with several steps that have to be restarted after an error Example APEX World, 31 maart 2017 Sabine Heimsath 11

12 1 Wrap your Transaction Control Statements APEX World, 31 maart 2017 Sabine Heimsath 12

13 1 Wrap your Transaction Control Statements APEX World, 31 maart 2017 Sabine Heimsath 13

14 1 Wrap your Transaction Control Statements How do you find all candidates for replacement? The correct answer for 12.2: PL/Scope APEX World, 31 maart 2017 Sabine Heimsath 14

15 1 Wrap your Transaction Control Statements 12.2 only APEX World, 31 maart 2017 Sabine Heimsath 15

16 1 Wrap your Transaction Control Statements <= 12.1 APEX World, 31 maart 2017 Sabine Heimsath 16

17 <= 12.1 Many false posititves. Sorry! APEX World, 31 maart 2017 Sabine Heimsath 17

18 2 Wrap DBMS_APPLICATION_INFO calls You There need is no call inherent nesting because ability to set module and action back to DBMS_APPLICATION_INFO.set_module( what module_name they were => null, action_name => null); you have to keep the values might somewhere loose information. yourself! begin end; pit.enter('my_block'); -- do something pit.enter('my_loop'); for... loop -- do some more end loop; pit.leave; -- leave loop -- final task pit.leave; -- leave func APEX World, 31 maart 2017 Sabine Heimsath 18

19 2 Wrap DBMS_APPLICATION_INFO calls Set module & action below the begin statement Update module & action for any new business task Place above all end and return statements! Place inside all exception handlers! begin pit.enter('my_func'); pit.info(...); -- the actual work pit.leave; return x; exception when others then pit.stop; end my_proc; APEX World, 31 maart 2017 Sabine Heimsath 19

20 3 Avoid placing calls inside loops APEX World, 31 maart 2017 Sabine Heimsath 20

21 3 Avoid placing No! calls inside loops APEX World, 31 maart 2017 Sabine Heimsath 21

22 3 Use DBMS_APPLICATION_INFO in Loops! DEMO (Session_Info progress) APEX World, 31 maart 2017 Sabine Heimsath 22

23 Four Open Source Frameworks Instrumentation Library for Oracle (ILO) + Oracle Logging Framework (OLF) Log4PLSQL Logger PL/SQL Instrumentation Toolkit (PIT) BMC_DEBUG APEX World, 31 maart 2017 Sabine Heimsath 23

24 ILO Builds a stack of calls on ILO_TASK.BEGIN_TASK and ILO_TASK.END_TASK Makes information available in v$session DBA or SELECT ANY DICTIONARY privilege needed Writes to trace file with ILO_TIMER.set_mark_all_tasks_interesting APEX World, 31 maart 2017 Sabine Heimsath 24

25 OLF Writes information to a logging table Dynamically set log levels depending on module, action, instance, user, sid Uses SQL Query Result Cache Two output modes: table or console (dbms_output) global config and log tables + optional local config and log tables APEX World, 31 maart 2017 Sabine Heimsath 25

26 begin ILO/OLF Example ilo_task.begin_task( module => 'module', action => 'action'); dblog.info('before statement'); null; -- something great here dblog.info('after statement'); ilo_task.end_task; exception when others then dblog.error(sqlerrm); ilo_task.end_all_tasks; raise; end; APEX World, 31 maart 2017 Sabine Heimsath 26

27 Logger Ora Open Source project Tip: have a look at their other projects, too!) Recommendation: Install in own schema - because needs CREATE ANY CONTEXT - and doesn t have access to your data NO-OP option for production environments if there are concerns Recommendation for production: Leave full version installed and set log level to ERROR as the performance hit is exceptionally small APEX World, 31 maart 2017 Sabine Heimsath 27

28 Logger Example procedure todo_proc_name(p_param1_todo in varchar2) as l_scope varchar2(30) := 'todo_proc_name'; l_params logger.tab_param; begin logger.append_param( l_params, 'p_param1_todo', p_param1_todo); logger.log('start', l_scope, null, l_params); null; -- more great code here logger.log('end', l_scope); exception when others then logger.log_error( 'Drama!', l_scope, null, l_params); raise; end todo_proc_name; APEX World, 31 maart 2017 Sabine Heimsath 28

29 Logger Example APEX World, 31 maart 2017 Sabine Heimsath 29

30 Log4plsql Many output channels beside the standard ones (table, file, console) through Advanced Queuing and Log4JBackgroundProcess: JDBC, JMS, SMTP, Socket, Telnet Uses DBMS_SYSTEM.ksdwrt (undocumented) to write trace files APEX World, 31 maart 2017 Sabine Heimsath 30

31 Log4plsql Example declare cpt number; begin plog.info('select raises ORA-01403:No Data Found'); select id into cpt from tlog where id = -1; exception when others then plog.error; end; APEX World, 31 maart 2017 Sabine Heimsath 31

32 PIT Comfortable APEX application for administration Many assert functions MSG package with automatically generated constants, error numbers and exceptions APEX World, 31 maart 2017 Sabine Heimsath 32

33 PIT Example procedure my_proc( p_id in number, p_string in varchar2) as begin pit.enter('my_proc', 'block'); pit.info(msg.gebabbel, msg_args(p_string ' and Klaas and Pit!')); null; -- do something smart here pit.leave; end my_proc; exec my_proc( , 'Hello Jan and Hein'); APEX World, 31 maart 2017 Sabine Heimsath 33

34 PIT Example Console PIT_LOG PIT_CALL_STACK APEX World, 31 maart 2017 Sabine Heimsath 34

35 Translation in progress APEX World, 31 maart 2017 Sabine Heimsath 35

36 APEX World, 31 maart 2017 Sabine Heimsath 36

37 APEX World, 31 maart 2017 Sabine Heimsath 37

38 APEX World, 31 maart 2017 Sabine Heimsath 38

39 APEX World, 31 maart 2017 Sabine Heimsath 39

40 Licenses ILO/OLF GNU Lesser General Public License Log4plsql Logger PIT BMC_DEBUG Apache Software License MIT License MIT License New BSD licence APEX World, 31 maart 2017 Sabine Heimsath 40

41 Activity ILO/OLF 2013 Log4plsql Logger PIT Fork in Github has changes a year ago Still active, fast responses Still active, fast responses BMC_DEBUG 2015 APEX World, 31 maart 2017 Sabine Heimsath 41

42 My Conclusion If you use your own instrumentation - fine If you are currently looking for a ready-to-go open source framework, Logger is a good choice If you have special requirements* - Log4PLSQL might fit for you If you want to experiment and test and have a nice APEX App for administration - go for PIT APEX World, 31 maart 2017 Sabine Heimsath 42

43 SQL Developer Enhancement Request Dim instrumentation code: APEX World, 31 maart 2017 Sabine Heimsath 43

44 SQL Developer Enhancement Request Show/hide instrumentation code: APEX World, 31 maart 2017 Sabine Heimsath 44

45 SQL Developer Enhancement Read more: Vote: Free OTN account needed APEX World, 31 maart 2017 Sabine Heimsath 45

46 Instrumentation Frameworks Logger PIT Log4plsql ILO BMC_DEBUG APEX World, 31 maart 2017 Sabine Heimsath 46

47 some last words You ll find your code easier to tune. You ll find your code easier to maintain over time. Your trace code, like Oracle s should always be there, just waiting to be enabled. Tom Kyte APEX World, 31 maart 2017 Sabine Heimsath 47

48 some final words Start instrumenting on Monday Make your customer happy and your DBA and yourself! APEX World, 31 maart 2017 Sabine Heimsath 48

49 we make the difference Dank u - Thank you - Danke! its-people GmbH Frankfurt Tel Hamburg Tel Köln Tel München Tel its-people ERP Beratungsgesellschaft mbh Frankfurt Tel info@its-people.de